├── arduino_testsuite ├── planned-tests.conf ├── planned-tests_long.conf ├── __init__.py ├── __main__.py ├── tests │ └── test.py ├── examples │ ├── floatingPin │ │ ├── floatingPin.ino │ │ └── SConstruct │ ├── simpleTest │ │ ├── simpleTest.ino │ │ └── SConstruct │ ├── slowTest │ │ ├── slowTest.ino │ │ └── SConstruct │ ├── inInterval │ │ ├── inInterval.ino │ │ └── SConstruct │ ├── buildErrorTest │ │ ├── buildErrorTest.ino │ │ └── SConstruct │ └── verySlowTest │ │ ├── verySlowTest.ino │ │ └── SConstruct ├── test.py ├── testhelper.py ├── main.py ├── infoprinter.py ├── settings.py └── testsuite.py ├── .gitignore ├── MANIFEST.in ├── .pydevproject ├── .project ├── setup.py ├── resources └── example.log ├── README.md ├── README.txt └── COPYING /arduino_testsuite/planned-tests.conf: -------------------------------------------------------------------------------- 1 | examples/floatingPin 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | dist 3 | build 4 | .sconsign.dblite 5 | *.elf 6 | *.hex 7 | *.log -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include *.txt 2 | include COPYING 3 | recursive-include ArduinoTestSuite *.txt *.py *.conf 4 | recursive-exclude ArduinoTestSuite *.pyc 5 | prune examples/sample?/build -------------------------------------------------------------------------------- /arduino_testsuite/planned-tests_long.conf: -------------------------------------------------------------------------------- 1 | examples/floatingPin 2 | examples/inInterval 3 | examples/simpleTest 4 | examples/buildErrorTest 5 | examples/nonExistingFolder 6 | examples/slowTest 7 | examples/verySlowTest -------------------------------------------------------------------------------- /arduino_testsuite/__init__.py: -------------------------------------------------------------------------------- 1 | """ arduino_testsuite: Initialize the package 2 | 3 | This file is needed to import the module properly 4 | The version number is used to generate the PyPI package 5 | 6 | """ 7 | __version__ = "0.2.2f" 8 | -------------------------------------------------------------------------------- /arduino_testsuite/__main__.py: -------------------------------------------------------------------------------- 1 | """ arduino_testsuite: Main file to run 2 | 3 | This file is needed to be able to run a Python program in a folder directly 4 | by calling "Python foldername" 5 | 6 | """ 7 | 8 | from arduino_testsuite.main import run 9 | 10 | if __name__ == '__main__': 11 | run() 12 | -------------------------------------------------------------------------------- /.pydevproject: -------------------------------------------------------------------------------- 1 | 2 | 3 | Default 4 | python 2.7 5 | 6 | -------------------------------------------------------------------------------- /arduino_testsuite/tests/test.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | 4 | class TestTheSuite(unittest.TestCase): 5 | """A placeholder for unit tests of this Python program""" 6 | 7 | def setUp(self): 8 | self.seq = range(10) 9 | 10 | def test_exitValueZero(self): 11 | self.assertEqual(0, 0) 12 | 13 | if __name__ == '__main__': 14 | unittest.main() 15 | -------------------------------------------------------------------------------- /arduino_testsuite/examples/floatingPin/floatingPin.ino: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | 4 | TestSuite suite; 5 | TestHelper helper; 6 | 7 | test(floatingInputPin) 8 | { 9 | assertTrue(!(helper.floatingInputPin(A0))); // true means: no floating input pins -> test passed 10 | } 11 | 12 | void setup() 13 | { 14 | Serial.begin(9600); 15 | } 16 | 17 | void loop() 18 | { 19 | suite.run(); 20 | } 21 | -------------------------------------------------------------------------------- /arduino_testsuite/examples/simpleTest/simpleTest.ino: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | TestSuite suite ("Simple Tests"); 4 | 5 | void setup() 6 | { 7 | Serial.begin(9600); 8 | } 9 | 10 | test(Passing) 11 | { 12 | assertTrue("True"); 13 | } 14 | 15 | test(Failing) 16 | { 17 | assertTrue("False"); 18 | } 19 | 20 | void loop() 21 | { 22 | // Run test suite, printing results to the serial port 23 | suite.run(); 24 | } 25 | -------------------------------------------------------------------------------- /.project: -------------------------------------------------------------------------------- 1 | 2 | 3 | arduino_testsuite 4 | 5 | 6 | 7 | 8 | 9 | org.python.pydev.PyDevBuilder 10 | 11 | 12 | 13 | 14 | 15 | org.python.pydev.pythonNature 16 | 17 | 18 | -------------------------------------------------------------------------------- /arduino_testsuite/examples/slowTest/slowTest.ino: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | TestSuite suite ("Slow test (with a 10s delay)"); 4 | 5 | void setup() 6 | { 7 | Serial.begin(9600); 8 | } 9 | 10 | test(Passing) 11 | { 12 | assertTrue("True"); 13 | } 14 | 15 | test(Failing) 16 | { 17 | assertTrue("False"); 18 | } 19 | 20 | void loop() 21 | { 22 | delay(10000); 23 | // Run test suite, printing results to the serial port 24 | suite.run(); 25 | } 26 | -------------------------------------------------------------------------------- /arduino_testsuite/examples/inInterval/inInterval.ino: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | 4 | TestSuite suite ("In Interval"); 5 | TestHelper helper; 6 | 7 | void setup() 8 | { 9 | Serial.begin(9600); 10 | } 11 | 12 | test(interval) 13 | { 14 | assertTrue(helper.inInterval(5,2,6)); // (data,lower,upper) 15 | } 16 | 17 | void loop() 18 | { 19 | // Run test suite, printing results to the serial port 20 | suite.run(); 21 | } 22 | -------------------------------------------------------------------------------- /arduino_testsuite/examples/buildErrorTest/buildErrorTest.ino: -------------------------------------------------------------------------------- 1 | THIS WILL GENERATE A BUILD ERROR 2 | #include 3 | 4 | TestSuite suite ("Simple Tests"); 5 | 6 | void setup() 7 | { 8 | Serial.begin(9600); 9 | } 10 | 11 | test(Passing) 12 | { 13 | assertTrue("True"); 14 | } 15 | 16 | test(Failing) 17 | { 18 | assertTrue("False"); 19 | } 20 | 21 | void loop() 22 | { 23 | // Run test suite, printing results to the serial port 24 | suite.run(); 25 | } 26 | -------------------------------------------------------------------------------- /arduino_testsuite/examples/verySlowTest/verySlowTest.ino: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | TestSuite suite ("Very slow test (with a 20s delay)"); 4 | 5 | void setup() 6 | { 7 | Serial.begin(9600); 8 | } 9 | 10 | test(Passing) 11 | { 12 | assertTrue("True"); 13 | } 14 | 15 | test(Failing) 16 | { 17 | assertTrue("False"); 18 | } 19 | 20 | void loop() 21 | { 22 | delay(20000); 23 | // Run test suite, printing results to the serial port 24 | suite.run(); 25 | } 26 | -------------------------------------------------------------------------------- /arduino_testsuite/test.py: -------------------------------------------------------------------------------- 1 | """ arduino_testsuite: Unit tests 2 | 3 | nothing useful in here at the moment 4 | 5 | """ 6 | 7 | import unittest 8 | 9 | 10 | class ArduinoTestSuite(unittest.TestCase): 11 | """Test the Arduino 12 | 13 | this part of the code could/should be called by 'nose' in the future 14 | 15 | """ 16 | 17 | def setup(self): 18 | """Do the test setup""" 19 | pass 20 | 21 | def test_run_arduino_tests(self): 22 | """Run the tests on the hardware""" 23 | self.assertEqual(0, 0) 24 | 25 | 26 | if __name__ == '__main__': 27 | unittest.main() 28 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | """Setup file for arduino_testsuite 2 | 3 | Define the options for the "arduino_testsuite" package 4 | Create source Python packages (python setup.py sdist) 5 | Create binary Python packages (python setup.py bdist) 6 | Upload these packages to PyPI (python setup.py sdist upload) 7 | 8 | """ 9 | from distutils.core import setup 10 | 11 | from arduino_testsuite import __version__ 12 | 13 | 14 | with open('README.txt') as readme_file: 15 | LONG_DESCRIPTION = readme_file.read() 16 | 17 | setup(name='arduino_testsuite', 18 | version=__version__, 19 | description='Arduino TestSuite for automated Arduino Unit Testing', 20 | long_description=LONG_DESCRIPTION, 21 | author='Jeroen Doggen', 22 | author_email='jeroendoggen@gmail.com', 23 | url='http://jeroendoggen.github.com/Arduino-TestSuite/', 24 | packages=['arduino_testsuite'], 25 | package_data={'arduino_testsuite': ['*.py', '*.conf']}, 26 | license='GNU General Public License v2 or later (GPLv2+)', 27 | platforms=['Linux'], 28 | ) 29 | -------------------------------------------------------------------------------- /arduino_testsuite/testhelper.py: -------------------------------------------------------------------------------- 1 | """ arduino_testsuite: Test helper functions 2 | 3 | run a command with a given timeout 4 | return the exit value for the program 5 | 6 | """ 7 | 8 | from __future__ import print_function, division # We require Python 2.6+ 9 | 10 | import time 11 | import subprocess 12 | import datetime 13 | import os 14 | import sys 15 | 16 | 17 | def timed_cmd(command, timeout): 18 | """Call a cmd and kill it after 'timeout' seconds""" 19 | cmd = command.split(" ") 20 | start = datetime.datetime.now() 21 | working_dir = os.path.dirname(sys.executable) 22 | process = subprocess.Popen(cmd, stdout=subprocess.PIPE, 23 | stderr=subprocess.PIPE, cwd=os.path.join(working_dir, "Scripts")) 24 | 25 | while process.poll() is None: 26 | now = datetime.datetime.now() 27 | time.sleep(1) 28 | if (now - start).seconds > timeout: 29 | print ("Process timeout") 30 | process.terminate() 31 | return None 32 | 33 | exit_code = process.poll() 34 | 35 | if exit_code != 0: 36 | stdout, stderr = process.communicate() 37 | 38 | print(stdout) 39 | print(stderr) 40 | 41 | return exit_code 42 | -------------------------------------------------------------------------------- /arduino_testsuite/main.py: -------------------------------------------------------------------------------- 1 | """ Arduino TestSuite to automate unit tests on the Arduino platform 2 | 3 | This file is needed to import the module properly 4 | Copyright (C) 2012 Jeroen Doggen 5 | 6 | This program is free software; you can redistribute it and/or 7 | modify it under the terms of the GNU General Public License 8 | as published by the Free Software Foundation; either version 2 9 | of the License, or (at your option) any later version. 10 | 11 | This program is distributed in the hope that it will be useful, 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | GNU General Public License for more details. 15 | 16 | You should have received a copy of the GNU General Public License 17 | along with this program; if not, write to the Free Software 18 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 19 | MA 02110-1301, USA. 20 | 21 | """ 22 | 23 | import sys 24 | 25 | from arduino_testsuite.testsuite import TestSuite 26 | 27 | 28 | def run(): 29 | """Run the main program""" 30 | suite = TestSuite() 31 | timeout = 10 32 | suite.print_planned_tests() 33 | suite.run_tests(timeout) 34 | suite.print_summary() 35 | return(suite.exit_value()) 36 | 37 | 38 | if __name__ == "__main__": 39 | sys.exit(run()) 40 | -------------------------------------------------------------------------------- /arduino_testsuite/infoprinter.py: -------------------------------------------------------------------------------- 1 | """ Print information messages 2 | 3 | This is currently used to keep the info messages out of the other code 4 | This can later be changed to become a logging interface. 5 | 6 | """ 7 | 8 | from __future__ import print_function, division # We require Python 2.6+ 9 | 10 | 11 | def double_line(): 12 | """Print a double line""" 13 | print ("=============================================================") 14 | 15 | 16 | def single_line(): 17 | """Print a single line""" 18 | print ("-------------------------------------------------------------") 19 | 20 | 21 | def top(): 22 | """Print the top of the cli message""" 23 | print ("") 24 | double_line() 25 | print ("Planned tests:") 26 | 27 | 28 | def programflow(): 29 | """Print the program flow""" 30 | print ("") 31 | print ("Program flow: ") 32 | print (" 1. Compile TestSuite sketch") 33 | print (" 2. Upload sketch using Arscons") 34 | print (" 3. Check unit test output") 35 | 36 | 37 | def planned_tests(test_list): 38 | """Print an overview of all the test that are planned""" 39 | top() 40 | for index, item in enumerate(test_list): 41 | print (" ", end="") 42 | print (index + 1, end="") 43 | print (". ", end="") 44 | print (item) 45 | programflow() 46 | 47 | 48 | def setup_info(index, current_test): 49 | """Print text at start of a test.""" 50 | print ("") 51 | double_line() 52 | print ("Starting test ", end="") 53 | print (index + 1, end=": ") 54 | print (current_test) 55 | single_line() 56 | print ("Compiling & uploading sketch to Arduino...") 57 | 58 | 59 | def summary(failedtest_list, passedtest_list): 60 | """Print the summary of all the tests.""" 61 | print ("") 62 | double_line() 63 | print ("Summary: ") 64 | single_line() 65 | print ("Failed tests:") 66 | for index, item in enumerate(failedtest_list): 67 | print (" " + str(index + 1) + "." + item) 68 | print ("") 69 | print ("Passed tests:") 70 | for index, item in enumerate(passedtest_list): 71 | print (" " + str(index + 1) + "." + item) 72 | double_line() 73 | print ("") 74 | 75 | 76 | def upload_status(state): 77 | """Print info about the outcome of the upload to the Arduino board.""" 78 | if (state == 0): 79 | print ("Upload succesful") 80 | #print(".", end="") 81 | else: 82 | print ("Upload Failed") 83 | -------------------------------------------------------------------------------- /resources/example.log: -------------------------------------------------------------------------------- 1 | 2 | ============================================================= 3 | Planned tests: 4 | 1. examples/floatingPin 5 | 2. examples/inInterval 6 | 3. examples/simpleTest 7 | 4. examples/buildErrorTest 8 | 5. examples/nonExistingFolder 9 | 6. examples/slowTest 10 | 7. examples/verySlowTest 11 | 12 | Program flow: 13 | 1. Compile TestSuite sketch 14 | 2. Upload sketch using Arscons 15 | 3. Check unit test output 16 | 17 | ============================================================= 18 | Starting test: examples/floatingPin 19 | ------------------------------------------------------------- 20 | Compiling & uploading sketch to Arduino... 21 | Starting upload... 22 | Upload succesfull 23 | Start tests... 24 | Running test suite... 25 | Assertion failed in 'floatingInputPin' on line 6 26 | Tests run: 1 Successful: 0 Failed: 1 27 | 28 | ============================================================= 29 | Starting test: examples/inInterval 30 | ------------------------------------------------------------- 31 | Compiling & uploading sketch to Arduino... 32 | Starting upload... 33 | Upload succesfull 34 | Start tests... 35 | Running test suite 'In Interval'... 36 | Tests run: 1 Successful: 1 Failed: 0 37 | 38 | ============================================================= 39 | Starting test: examples/simpleTest 40 | ------------------------------------------------------------- 41 | Compiling & uploading sketch to Arduino... 42 | Starting upload... 43 | Upload succesfull 44 | Start tests... 45 | Running test suite 'Simple Tests'... 46 | Tests run: 2 Successful: 2 Failed: 0 47 | 48 | ============================================================= 49 | Starting test: examples/buildErrorTest 50 | ------------------------------------------------------------- 51 | Compiling & uploading sketch to Arduino... 52 | Starting upload... 53 | Upload Failed 54 | 55 | ============================================================= 56 | Starting test: examples/nonExistingFolder 57 | ------------------------------------------------------------- 58 | Compiling & uploading sketch to Arduino... 59 | Error: unable to open test folder 60 | Check your config file 61 | 62 | ============================================================= 63 | Starting test: examples/slowTest 64 | ------------------------------------------------------------- 65 | Compiling & uploading sketch to Arduino... 66 | Starting upload... 67 | Upload succesfull 68 | Start tests... 69 | Running test suite 'Slow test (with a 10s delay)'... 70 | Tests run: 2 Successful: 2 Failed: 0 71 | 72 | ============================================================= 73 | Starting test: examples/verySlowTest 74 | ------------------------------------------------------------- 75 | Compiling & uploading sketch to Arduino... 76 | Starting upload... 77 | Upload succesfull 78 | Start tests... 79 | Running test suite 'Very slow test (with a 20s delay)'... 80 | Test timeout after 10 seconds 81 | 82 | ============================================================= 83 | Summary: 84 | ------------------------------------------------------------- 85 | Failed tests: 86 | 1.examples/floatingPin 87 | 2.examples/buildErrorTest 88 | 3.examples/nonExistingFolder 89 | 4.examples/verySlowTest 90 | 91 | Passed tests: 92 | 1.examples/inInterval 93 | 2.examples/simpleTest 94 | 3.examples/slowTest 95 | ============================================================= 96 | 97 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Arduino TestSuite: Automated Arduino Unit Tests 2 | =============================================== 3 | This Python scripts allows automated running of several Arduino unit tests. 4 | The testing process is started on the PC but the tests run on the actual Arduino hardware. 5 | One set of unit tests is typically used to test one Arduino library. 6 | 7 | The following steps are performed for each set of unit tests: 8 | 1. The script compiles and uploads an Arduino sketch that contains the unit testing. 9 | 2. The unit tests are run on the Arduino board. 10 | 3. The results of the test are printed over the serial port and analyzed by the Python script. 11 | 4. The script starts the next test, repeating steps 1,2 and 3 for all test that are requested in the configuration file. 12 | The script prints a summary showing an overview of all the failed/passed tests in the complete testsuite. 13 | 14 | Installation: 15 | ------------- 16 | * Download the source and run ``python setup.py install`` 17 | * Python Package available in the Python Package Index at: http://pypi.python.org/pypi/arduino_testsuite 18 | * Install using pip: ``pip install arduino_testsuite`` 19 | 20 | Usage: 21 | ------ 22 | * Start the program with: ``python -m arduino_testsuite`` 23 | * Select the tests you want to run by editing: ``planned-tests.conf`` 24 | * Getting help: ``python -m arduino_testsuite --help`` 25 | * Post issues to GitHub http://github.com/jeroendoggen/Arduino-TestSuite/issues. 26 | 27 | Typical test output: 28 | -------------------- 29 | 30 | user@computer:~/tests$ python -m arduino_testsuite 31 | ============================== 32 | Planned tests: 33 | 1. examples/floatingPin 34 | 2. examples/inInterval 35 | 3. examples/simpleTest 36 | 4. examples/buildErrorTest 37 | 5. examples/nonExistingFolder 38 | 6. examples/slowTest 39 | 7. examples/verySlowTest 40 | ============================== 41 | .... output normally continues for a while ... link to full log below. 42 | 43 | https://raw.github.com/jeroendoggen/Arduino-TestSuite/master/resources/example.log 44 | 45 | Requirements: 46 | ------------- 47 | * The unit tests are written with the "Arduino Unit Testing Library": http://code.google.com/p/arduinounit 48 | * The tests also use "Arduino Unit Testing Helper Library": http://code.google.com/p/arduino-unit-test-helper-library 49 | * The code is uploaded to the Arduino board with "Arscons: scons script for Arduino": http://github.com/suapapa/arscons 50 | * Python 2.6+ packages: pyserial 51 | 52 | Limitations: 53 | ------------ 54 | * Currently only tested on Linux and Windows 7 55 | * The program was created with other OS users in mind, so it will eventually get full cross-platform support. 56 | 57 | License: 58 | -------- 59 | If not stated otherwise arduino_testsuite is distributed in terms of the GPLv2 software license. 60 | See COPYING in the distribution for details. 61 | 62 | Bug reports: 63 | ------------ 64 | * Jeroen Doggen 65 | 66 | Changelog: 67 | ---------- 68 | 0.2.2: Error handling: 69 | * Compile & upload errors 70 | * Timing: timeout for uploading & running of the tests 71 | * Missing files: wrong test folder, no config file 72 | * Hardware: Disconnect Arduino during test 73 | 74 | 0.2.1: Settings & configuration 75 | * Passing cli arguments & cli help messages 76 | * Settings separated from other code 77 | * Start tests from config file 78 | 79 | 0.2: First working OOP version 80 | * Subprocess for arscons 81 | * Classes: Test, TestSuite, InfoPrinter 82 | * Divided the code in several modules 83 | 84 | 0.1: Initial release: 85 | * Call scons 86 | * Run unit test 87 | * Print summary 88 | -------------------------------------------------------------------------------- /arduino_testsuite/settings.py: -------------------------------------------------------------------------------- 1 | """ arduino_testsuite: Settings class 2 | 3 | get the cli arguments 4 | setup the serial port 5 | read the config file 6 | 7 | """ 8 | 9 | from __future__ import print_function, division # We require Python 2.6+ 10 | 11 | import argparse 12 | import sys 13 | import logging 14 | import platform 15 | 16 | try: 17 | import serial 18 | except ImportError as exc: 19 | print("Error: failed to import pyserial module") 20 | print("Solution: you probably need to install the pyserial module") 21 | sys.exit(0) 22 | 23 | logging.basicConfig(filename='example.log', 24 | level=logging.DEBUG, 25 | format="%(asctime)s %(name)s %(message)s") 26 | LOGGER = logging.getLogger(__name__) 27 | 28 | 29 | class Settings: 30 | """Configure the settings of the program""" 31 | DEFAULT_PORT_UNIX = "/dev/ttyUSB0" 32 | DEFAULT_PORT_WINDOWS = "COM3" 33 | DEFAULT_BOARD = "atmega328" 34 | DEFAULT_BAUDRATE = 9600 35 | DEFAULT_CONFIGFILE = "planned-tests.conf" 36 | board = DEFAULT_BOARD 37 | baudrate = DEFAULT_BAUDRATE 38 | config_file = DEFAULT_CONFIGFILE 39 | 40 | def __init__(self): 41 | """Initialize the platform-specific serial port""" 42 | self.serial_port = self.default_port() 43 | 44 | def get_cli_arguments(self): 45 | """Read all the cli arguments.""" 46 | """This needs to be indented like this to print it correctly on cli""" 47 | parser = argparse.ArgumentParser( 48 | prog="arduino_testsuite", 49 | formatter_class=argparse.RawDescriptionHelpFormatter, 50 | description="Arduino TestSuite commandline arguments:", 51 | epilog="Report bugs to jeroendoggen@gmail.com.") 52 | parser.add_argument("-p", metavar="port", 53 | help="Set the name of the serial port") 54 | parser.add_argument('-d', metavar='board', 55 | help='Set the name of the board as defined in boards.txt') 56 | parser.add_argument("-f", metavar="file", 57 | help="Select the inputfile containing the requested tests") 58 | parser.add_argument("-b", metavar="baudrate", 59 | help="Set the baudrate of the serial port") 60 | args = parser.parse_args() 61 | if (args.p is not None): 62 | self.serial_port = args.p 63 | if (args.d is not None): 64 | self.board = args.d 65 | if (args.f is not None): 66 | self.config_file = args.f 67 | if (args.b is not None): 68 | self.baudrate = args.b 69 | 70 | def init_serial_port(self): 71 | """Initialize the serial port.""" 72 | try: 73 | ser = serial.Serial(self.serial_port, self.baudrate) 74 | ser.flush() 75 | except IOError: 76 | LOGGER.warning("Unable to connect to serial port") 77 | print("Unable to connect to serial port: ", end="") 78 | print(self.serial_port) 79 | sys.exit(1) 80 | return(ser) 81 | 82 | def read_testlist_file(self): 83 | """Read the config file to get the testlist.""" 84 | test_list = [] 85 | try: 86 | with open(self.config_file, "r") as configfile: 87 | test_list = configfile.read().splitlines() 88 | except IOError: 89 | print ("Error: 'planned-tests.conf' not found!") 90 | print ("Aborting test session.") 91 | sys.exit(1) 92 | return test_list 93 | 94 | def default_port(self): 95 | """Get the default serial port on different platforms""" 96 | if platform.system() == 'Windows': 97 | return self.DEFAULT_PORT_WINDOWS 98 | 99 | return self.DEFAULT_PORT_UNIX 100 | -------------------------------------------------------------------------------- /README.txt: -------------------------------------------------------------------------------- 1 | Arduino TestSuite: Automated Arduino Unit Tests 2 | =============================================== 3 | This Python scripts allows automated running of several Arduino unit tests. 4 | The testing process is started on the PC but the tests run on the actual Arduino hardware. 5 | One set of unit tests is typically used to test one Arduino library. 6 | 7 | The following steps are performed for each set of unit tests: 8 | 1. The script compiles and uploads an Arduino sketch that contains the unit testing. 9 | 2. The unit tests are run on the Arduino board. 10 | 3. The results of the test are printed over the serial port and analyzed by the Python script. 11 | 4. The script starts the next test, repeating steps 1,2 and 3 for all test that are requested in the configuration file. 12 | The script prints a summary showing an overview of all the failed/passed tests in the complete testsuite. 13 | 14 | Installation: 15 | ------------- 16 | * Download the source and run ``python setup.py install`` 17 | * Python Package available in the Python Package Index at: http://pypi.python.org/pypi/arduino_testsuite 18 | * Install using pip: ``pip install arduino_testsuite`` 19 | 20 | Usage: 21 | ------ 22 | * Start the program with: ``python -m arduino_testsuite`` 23 | * Select the tests you want to run by editing: ``planned-tests.conf`` 24 | * Getting help: ``python -m arduino_testsuite --help`` 25 | * Post issues to GitHub http://github.com/jeroendoggen/Arduino-TestSuite/issues. 26 | 27 | Typical test output: 28 | -------------------- 29 | 30 | user@computer:~/tests$ python -m arduino_testsuite 31 | ============================== 32 | Planned tests: 33 | 1. examples/floatingPin 34 | 2. examples/inInterval 35 | 3. examples/simpleTest 36 | 4. examples/buildErrorTest 37 | 5. examples/nonExistingFolder 38 | 6. examples/slowTest 39 | 7. examples/verySlowTest 40 | ============================== 41 | .... output normally continues for a while ... link to full log below. 42 | 43 | https://raw.github.com/jeroendoggen/Arduino-TestSuite/master/resources/example.log 44 | 45 | Requirements: 46 | ------------- 47 | * The unit tests are written with the "Arduino Unit Testing Library": http://code.google.com/p/arduinounit 48 | * The tests also use "Arduino Unit Testing Helper Library": http://code.google.com/p/arduino-unit-test-helper-library 49 | * The code is uploaded to the Arduino board with "Arscons: scons script for Arduino": http://github.com/suapapa/arscons 50 | * Python 2.6+ packages: pyserial 51 | 52 | Limitations: 53 | ------------ 54 | * Currently only tested on Linux 55 | 56 | * Default paths are configured for Linux 57 | * Subprocess handling only works on Linux 58 | 59 | * The program was created with other OS users in mind, so it will eventually get full cross-platform support. Help from Windows-developers is much appreciated. 60 | 61 | License: 62 | -------- 63 | If not stated otherwise arduino_testsuite is distributed in terms of the GPLv2 software license. 64 | See COPYING in the distribution for details. 65 | 66 | Bug reports: 67 | ------------ 68 | * Jeroen Doggen 69 | 70 | Changelog: 71 | ---------- 72 | 0.2.2: Error handling: 73 | * Compile & upload errors 74 | * Timing: timeout for uploading & running of the tests 75 | * Missing files: wrong test folder, no config file 76 | * Hardware: Disconnect Arduino during test 77 | 78 | 0.2.1: Settings & configuration 79 | * Passing cli arguments & cli help messages 80 | * Settings separated from other code 81 | * Start tests from config file 82 | 83 | 0.2: First working OOP version 84 | * Subprocess for arscons 85 | * Classes: Test, TestSuite, InfoPrinter 86 | * Divided the code in several modules 87 | 88 | 0.1: Initial release: 89 | * Call scons 90 | * Run unit test 91 | * Print summary 92 | -------------------------------------------------------------------------------- /arduino_testsuite/testsuite.py: -------------------------------------------------------------------------------- 1 | """ arduino_testsuite: core code 2 | 3 | This is currently used to keep the info messages out of the other code 4 | This can later be changed to become a logging interface. 5 | 6 | """ 7 | from __future__ import print_function, division # We require Python 2.6+ 8 | 9 | import os 10 | import time 11 | import datetime 12 | import platform 13 | 14 | import infoprinter 15 | import testhelper 16 | from arduino_testsuite.settings import Settings 17 | 18 | 19 | class TestSuite: 20 | """TestSuite class: does the core of the work""" 21 | not_finished = True # boolean value 22 | found_test_path = False 23 | upload_status = False 24 | failed_test_list = [] 25 | passed_test_list = [] 26 | failure_count = 0 27 | line = [] 28 | test_list = [] 29 | config = Settings() 30 | scriptpath = os.getcwd() 31 | 32 | def __init__(self): 33 | """Initialize the suite: cli, config file.""" 34 | self.config.get_cli_arguments() 35 | self.test_list = self.config.read_testlist_file() 36 | 37 | def print_planned_tests(self): 38 | """Print an overview of all the test that are planned""" 39 | infoprinter.planned_tests(self.test_list) 40 | infoprinter.programflow() 41 | 42 | def run_tests(self, timeout): 43 | """Run all the tests""" 44 | for index, current_test in enumerate(self.test_list): 45 | self.goto_testpath(index, current_test) 46 | if (self.found_test_path): 47 | self.found_test_path = False 48 | print("Starting upload...") 49 | self.upload_sketch(timeout) 50 | if (self.upload_status == 0): 51 | print("Start tests...") 52 | self.analyze_output(timeout, current_test) 53 | else: 54 | self.failed_test_list.append(current_test) 55 | 56 | def goto_testpath(self, index, current_test): 57 | """Go to the folder of the current test""" 58 | infoprinter.setup_info(index, current_test) 59 | try: 60 | os.chdir(self.scriptpath) 61 | except OSError: 62 | print("Error: unable to open the script folder") 63 | print("This should never happen...") 64 | try: 65 | os.chdir(current_test) 66 | self.found_test_path = True 67 | except OSError: 68 | print("Error: unable to open test folder") 69 | print("Check your config file") 70 | self.found_test_path = False 71 | self.failed_test_list.append(current_test) 72 | 73 | def upload_sketch(self, timeout): 74 | """Upload the sketch to the Arduino board""" 75 | scons_command = "scons" 76 | if platform.system() == 'Windows': 77 | scons_command += ".bat" 78 | sconstruct_dir_argument = "--directory=" + os.getcwd() 79 | port_argument = "ARDUINO_PORT=" + self.config.serial_port 80 | board_argument = "ARDUINO_BOARD=" + self.config.board 81 | self.upload_status = testhelper.timed_cmd( 82 | scons_command + " " + 83 | sconstruct_dir_argument + " " + 84 | port_argument + " " + 85 | board_argument + " " + 86 | "upload", timeout) 87 | infoprinter.upload_status(self.upload_status) 88 | 89 | def analyze_output(self, timeout, current_test): 90 | """Analyze the test output that is received over the serial port""" 91 | serial_port = self.config.init_serial_port() 92 | 93 | start = datetime.datetime.now() 94 | while self.not_finished: 95 | self.read_line(serial_port, current_test) 96 | time.sleep(0.1) 97 | now = datetime.datetime.now() 98 | if (now - start).seconds > timeout: 99 | print ("Test timeout after ", end="") 100 | print (timeout, end="") 101 | print (" seconds") 102 | self.not_finished = False 103 | self.not_finished = True # to allow the next test to start 104 | if (self.line[11] == self.line[25]): 105 | if current_test not in self.failed_test_list: 106 | self.passed_test_list.append(current_test) 107 | else: 108 | self.failed_test_list.append(current_test) 109 | self.failure_count = self.failure_count + 1 110 | 111 | serial_port.close() 112 | 113 | def read_line(self, serial_port, current_test): 114 | """Read one line of text over the serial port""" 115 | try: 116 | self.line = serial_port.readline().decode('utf-8')[:-1] 117 | print (self.line) 118 | except IOError: 119 | print ("unexpectedly lost serial connection") 120 | self.failed_test_list.append(current_test) 121 | if(self.line.find("Tests run:") == 0): 122 | self.not_finished = False 123 | 124 | def print_summary(self): 125 | """Print the summary of all the tests.""" 126 | infoprinter.summary(self.failed_test_list, self.passed_test_list) 127 | 128 | def exit_value(self): 129 | """Generate the exit value for the application.""" 130 | if (self.failure_count == 0): 131 | return 0 132 | else: 133 | return 42 134 | -------------------------------------------------------------------------------- /arduino_testsuite/examples/slowTest/SConstruct: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | # scons script for the Arduino sketch 4 | # http://github.com/suapapa/arscons 5 | # 6 | # Copyright (C) 2010-2012 by Homin Lee 7 | # 8 | # This program is free software; you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation; either version 3 of the License, or 11 | # (at your option) any later version. 12 | 13 | # You'll need the serial module: http://pypi.python.org/pypi/pyserial 14 | 15 | # Basic Usage: 16 | # 1. make a folder which have same name of the sketch (ex. Blink/ for Blink.pde) 17 | # 2. put the sketch and SConstruct(this file) under the folder. 18 | # 3. to make the HEX. do following in the folder. 19 | # $ scons 20 | # 4. to upload the binary, do following in the folder. 21 | # $ scons upload 22 | 23 | # Thanks to: 24 | # * Ovidiu Predescu and Lee Pike 25 | # for Mac port and bugfix. 26 | # 27 | # This script tries to determine the port to which you have an Arduino 28 | # attached. If multiple USB serial devices are attached to your 29 | # computer, you'll need to explicitly specify the port to use, like 30 | # this: 31 | # 32 | # $ scons ARDUINO_PORT=/dev/ttyUSB0 33 | # 34 | # To add your own directory containing user libraries, pass EXTRA_LIB 35 | # to scons, like this: 36 | # 37 | # $ scons EXTRA_LIB= 38 | # 39 | 40 | from glob import glob 41 | from itertools import ifilter, imap 42 | from subprocess import check_call, CalledProcessError 43 | import sys 44 | import re 45 | import os 46 | from os import path 47 | from pprint import pprint 48 | 49 | env = Environment() 50 | platform = env['PLATFORM'] 51 | 52 | VARTAB = {} 53 | 54 | def resolve_var(varname, default_value): 55 | global VARTAB 56 | # precedence: scons argument -> environment variable -> default value 57 | ret = ARGUMENTS.get(varname, None) 58 | VARTAB[varname] = ('arg', ret) 59 | if ret == None: 60 | ret = os.environ.get(varname, None) 61 | VARTAB[varname] = ('env', ret) 62 | if ret == None: 63 | ret = default_value 64 | VARTAB[varname] = ('dfl', ret) 65 | return ret 66 | 67 | def getUsbTty(rx): 68 | usb_ttys = glob(rx) 69 | return usb_ttys[0] if len(usb_ttys) == 1 else None 70 | 71 | AVR_BIN_PREFIX = None 72 | AVRDUDE_CONF = None 73 | 74 | if platform == 'darwin': 75 | # For MacOS X, pick up the AVR tools from within Arduino.app 76 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', 77 | '/Applications/Arduino.app/Contents/Resources/Java') 78 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', getUsbTty('/dev/tty.usbserial*')) 79 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', '') 80 | AVR_HOME = resolve_var('AVR_HOME', 81 | path.join(ARDUINO_HOME, 'hardware/tools/avr/bin')) 82 | elif platform == 'win32': 83 | # For Windows, use environment variables. 84 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', None) 85 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', '') 86 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', '') 87 | if ARDUINO_HOME: 88 | AVR_HOME = resolve_var('AVR_HOME', 89 | path.join(ARDUINO_HOME, 'hardware/tools/avr/bin')) 90 | else: 91 | # For Ubuntu Linux (9.10 or higher) 92 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', '/usr/share/arduino/') 93 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', getUsbTty('/dev/ttyUSB*')) 94 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', 95 | path.expanduser('~/share/arduino/sketchbook/')) 96 | AVR_HOME = resolve_var('AVR_HOME', '') 97 | 98 | 99 | ARDUINO_BOARD = resolve_var('ARDUINO_BOARD', 'atmega328') 100 | ARDUINO_VER = resolve_var('ARDUINO_VER', 0) # Default to 0 if nothing is specified 101 | RST_TRIGGER = resolve_var('RST_TRIGGER', None) # use built-in pulseDTR() by default 102 | EXTRA_LIB = resolve_var('EXTRA_LIB', None) # handy for adding another arduino-lib dir 103 | 104 | pprint(VARTAB, indent = 4) 105 | 106 | if not ARDUINO_HOME: 107 | print 'ARDUINO_HOME must be defined.' 108 | raise KeyError('ARDUINO_HOME') 109 | 110 | ARDUINO_CONF = path.join(ARDUINO_HOME, 'hardware/arduino/boards.txt') 111 | # check given board name, ARDUINO_BOARD is valid one 112 | arduino_boards = path.join(ARDUINO_HOME,'hardware/*/boards.txt') 113 | custom_boards = path.join(SKETCHBOOK_HOME,'hardware/*/boards.txt') 114 | board_files = glob(arduino_boards) + glob(custom_boards) 115 | ptnBoard = re.compile(r'^([^#]*)\.name=(.*)') 116 | boards = {} 117 | for bf in board_files: 118 | for line in open(bf): 119 | result = ptnBoard.match(line) 120 | if result: 121 | boards[result.group(1)] = (result.group(2), bf) 122 | 123 | if ARDUINO_BOARD not in boards: 124 | print "ERROR! the given board name, %s is not in the supported board list:" % ARDUINO_BOARD 125 | print "all available board names are:" 126 | for name, description in boards.iteritems(): 127 | print "\t%s for %s" % (name.ljust(14), description[0]) 128 | #print "however, you may edit %s to add a new board." % ARDUINO_CONF 129 | sys.exit(-1) 130 | 131 | ARDUINO_CONF = boards[ARDUINO_BOARD][1] 132 | 133 | def getBoardConf(conf, default = None): 134 | for line in open(ARDUINO_CONF): 135 | line = line.strip() 136 | if '=' in line: 137 | key, value = line.split('=') 138 | if key == '.'.join([ARDUINO_BOARD, conf]): 139 | return value 140 | ret = default 141 | if ret == None: 142 | print "ERROR! can't find %s in %s" % (conf, ARDUINO_CONF) 143 | assert(False) 144 | return ret 145 | 146 | ARDUINO_CORE = path.join(ARDUINO_HOME, path.dirname(ARDUINO_CONF), 147 | 'cores/', getBoardConf('build.core', 'arduino')) 148 | ARDUINO_SKEL = path.join(ARDUINO_CORE, 'main.cpp') 149 | 150 | if ARDUINO_VER == 0: 151 | arduinoHeader = path.join(ARDUINO_CORE, 'Arduino.h') 152 | print "No Arduino version specified. Discovered version", 153 | if path.exists(arduinoHeader): 154 | print "100 or above" 155 | ARDUINO_VER = 100 156 | else: 157 | print "0023 or below" 158 | ARDUINO_VER = 23 159 | else: 160 | print "Arduino version " + ARDUINO_VER + " specified" 161 | 162 | # Some OSs need bundle with IDE tool-chain 163 | if platform == 'darwin' or platform == 'win32': 164 | AVRDUDE_CONF = path.join(ARDUINO_HOME, 'hardware/tools/avr/etc/avrdude.conf') 165 | 166 | AVR_BIN_PREFIX = path.join(AVR_HOME, 'avr-') 167 | 168 | ARDUINO_LIBS = [path.join(ARDUINO_HOME, 'libraries')] 169 | if EXTRA_LIB: 170 | ARDUINO_LIBS.append(EXTRA_LIB) 171 | if SKETCHBOOK_HOME: 172 | ARDUINO_LIBS.append(path.join(SKETCHBOOK_HOME, 'libraries')) 173 | 174 | 175 | # Override MCU and F_CPU 176 | MCU = ARGUMENTS.get('MCU', getBoardConf('build.mcu')) 177 | F_CPU = ARGUMENTS.get('F_CPU', getBoardConf('build.f_cpu')) 178 | 179 | # There should be a file with the same name as the folder and 180 | # with the extension .pde or .ino 181 | TARGET = path.basename(path.realpath(os.curdir)) 182 | assert(path.exists(TARGET + '.ino') or path.exists(TARGET + '.pde')) 183 | sketchExt = '.ino' if path.exists(TARGET + '.ino') else '.pde' 184 | 185 | cFlags = ['-ffunction-sections', '-fdata-sections', '-fno-exceptions', 186 | '-funsigned-char', '-funsigned-bitfields', '-fpack-struct', 187 | '-fshort-enums', '-Os', '-Wall', '-mmcu=%s' % MCU] 188 | envArduino = Environment(CC = AVR_BIN_PREFIX + 'gcc', 189 | CXX = AVR_BIN_PREFIX + 'g++', 190 | AS = AVR_BIN_PREFIX + 'gcc', 191 | CPPPATH = ['build/core'], 192 | CPPDEFINES = {'F_CPU': F_CPU, 'ARDUINO': ARDUINO_VER}, 193 | CFLAGS = cFlags + ['-std=gnu99'], 194 | CCFLAGS = cFlags, 195 | ASFLAGS = ['-assembler-with-cpp','-mmcu=%s' % MCU], 196 | TOOLS = ['gcc','g++', 'as']) 197 | 198 | hwVariant = path.join(ARDUINO_HOME, 'hardware/arduino/variants', 199 | getBoardConf("build.variant", "")) 200 | if hwVariant: 201 | envArduino.Append(CPPPATH = hwVariant) 202 | 203 | def run(cmd): 204 | """Run a command and decipher the return code. Exit by default.""" 205 | print ' '.join(cmd) 206 | try: 207 | check_call(cmd) 208 | except CalledProcessError as cpe: 209 | print "Error: return code: " + str(cpe.returncode) 210 | sys.exit(cpe.returncode) 211 | 212 | # WindowXP not supported path.samefile 213 | def sameFile(p1, p2): 214 | if platform == 'win32': 215 | ap1 = path.abspath(p1) 216 | ap2 = path.abspath(p2) 217 | return ap1 == ap2 218 | return path.samefile(p1, p2) 219 | 220 | def fnProcessing(target, source, env): 221 | wp = open(str(target[0]), 'wb') 222 | wp.write(open(ARDUINO_SKEL).read()) 223 | 224 | types='''void 225 | int char word long 226 | float double byte long 227 | boolean 228 | uint8_t uint16_t uint32_t 229 | int8_t int16_t int32_t''' 230 | types=' | '.join(types.split()) 231 | re_signature = re.compile(r"""^\s* ( 232 | (?: (%s) \s+ )? 233 | \w+ \s* 234 | \( \s* ((%s) \s+ \*? \w+ (?:\s*,\s*)? )* \) 235 | ) \s* {? \s* $""" % (types, types), re.MULTILINE | re.VERBOSE) 236 | 237 | prototypes = {} 238 | 239 | for file in glob(path.realpath(os.curdir) + "/*" + sketchExt): 240 | for line in open(file): 241 | result = re_signature.search(line) 242 | if result: 243 | prototypes[result.group(1)] = result.group(2) 244 | 245 | for name in prototypes.iterkeys(): 246 | print "%s;" % name 247 | wp.write("%s;\n" % name) 248 | 249 | for file in glob(path.realpath(os.curdir) + "/*" + sketchExt): 250 | print file, TARGET 251 | if not sameFile(file, TARGET + sketchExt): 252 | wp.write('#line 1 "%s"\r\n' % file) 253 | wp.write(open(file).read()) 254 | 255 | # Add this preprocessor directive to localize the errors. 256 | sourcePath = str(source[0]).replace('\\', '\\\\') 257 | wp.write('#line 1 "%s"\r\n' % sourcePath) 258 | wp.write(open(str(source[0])).read()) 259 | 260 | def fnCompressCore(target, source, env): 261 | core_prefix = 'build/core/'.replace('/', os.path.sep) 262 | core_files = (x for x in imap(str, source) 263 | if x.startswith(core_prefix)) 264 | for file in core_files: 265 | run([AVR_BIN_PREFIX + 'ar', 'rcs', str(target[0]), file]) 266 | 267 | bldProcessing = Builder(action = fnProcessing) #, suffix = '.cpp', src_suffix = sketchExt) 268 | bldCompressCore = Builder(action = fnCompressCore) 269 | bldELF = Builder(action = AVR_BIN_PREFIX + 'gcc -mmcu=%s ' % MCU + 270 | '-Os -Wl,--gc-sections -lm -o $TARGET $SOURCES -lc') 271 | bldHEX = Builder(action = AVR_BIN_PREFIX + 'objcopy -O ihex -R .eeprom $SOURCES $TARGET') 272 | 273 | envArduino.Append(BUILDERS = {'Processing' : bldProcessing}) 274 | envArduino.Append(BUILDERS = {'CompressCore': bldCompressCore}) 275 | envArduino.Append(BUILDERS = {'Elf' : bldELF}) 276 | envArduino.Append(BUILDERS = {'Hex' : bldHEX}) 277 | 278 | ptnSource = re.compile(r'\.(?:c(?:pp)?|S)$') 279 | def gatherSources(srcpath): 280 | return [path.join(srcpath, f) for f 281 | in os.listdir(srcpath) if ptnSource.search(f)] 282 | 283 | # add arduino core sources 284 | VariantDir('build/core', ARDUINO_CORE) 285 | core_sources = gatherSources(ARDUINO_CORE) 286 | core_sources = [x.replace(ARDUINO_CORE, 'build/core/') for x 287 | in core_sources if path.basename(x) != 'main.cpp'] 288 | 289 | # add libraries 290 | libCandidates = [] 291 | ptnLib = re.compile(r'^[ ]*#[ ]*include [<"](.*)\.h[>"]') 292 | for line in open(TARGET + sketchExt): 293 | result = ptnLib.search(line) 294 | if not result: 295 | continue 296 | # Look for the library directory that contains the header. 297 | filename = result.group(1) + '.h' 298 | for libdir in ARDUINO_LIBS: 299 | for root, dirs, files in os.walk(libdir, followlinks=True): 300 | if filename in files: 301 | libCandidates.append(path.basename(root)) 302 | 303 | # Hack. In version 20 of the Arduino IDE, the Ethernet library depends 304 | # implicitly on the SPI library. 305 | if ARDUINO_VER >= 20 and 'Ethernet' in libCandidates: 306 | libCandidates.append('SPI') 307 | 308 | all_libs_sources = [] 309 | for index, orig_lib_dir in enumerate(ARDUINO_LIBS): 310 | lib_dir = 'build/lib_%02d' % index 311 | VariantDir(lib_dir, orig_lib_dir) 312 | for libPath in ifilter(path.isdir, glob(path.join(orig_lib_dir, '*'))): 313 | libName = path.basename(libPath) 314 | if not libName in libCandidates: 315 | continue 316 | envArduino.Append(CPPPATH = libPath.replace(orig_lib_dir, lib_dir)) 317 | lib_sources = gatherSources(libPath) 318 | utilDir = path.join(libPath, 'utility') 319 | if path.exists(utilDir) and path.isdir(utilDir): 320 | lib_sources += gatherSources(utilDir) 321 | envArduino.Append(CPPPATH = utilDir.replace(orig_lib_dir, lib_dir)) 322 | lib_sources = (x.replace(orig_lib_dir, lib_dir) for x in lib_sources) 323 | all_libs_sources.extend(lib_sources) 324 | 325 | # Add raw sources which live in sketch dir. 326 | build_top = path.realpath('.') 327 | VariantDir('build/local/', build_top) 328 | local_sources = gatherSources(build_top) 329 | local_sources = [x.replace(build_top, 'build/local/') for x in local_sources] 330 | if local_sources: 331 | envArduino.Append(CPPPATH = 'build/local') 332 | 333 | # Convert sketch(.pde) to cpp 334 | envArduino.Processing('build/' + TARGET + '.cpp', 'build/' + TARGET + sketchExt) 335 | VariantDir('build', '.') 336 | 337 | sources = ['build/' + TARGET + '.cpp'] 338 | #sources += core_sources 339 | sources += local_sources 340 | sources += all_libs_sources 341 | 342 | # Finally Build!! 343 | core_objs = envArduino.Object(core_sources) 344 | objs = envArduino.Object(sources) #, LIBS=libs, LIBPATH='.') 345 | objs = objs + envArduino.CompressCore('build/core.a', core_objs) 346 | envArduino.Elf(TARGET + '.elf', objs) 347 | envArduino.Hex(TARGET + '.hex', TARGET + '.elf') 348 | 349 | # Print Size 350 | # TODO: check binary size 351 | MAX_SIZE = getBoardConf('upload.maximum_size') 352 | print "maximum size for hex file: %s bytes" % MAX_SIZE 353 | envArduino.Command(None, TARGET + '.hex', AVR_BIN_PREFIX + 'size --target=ihex $SOURCE') 354 | 355 | # Reset 356 | def pulseDTR(target, source, env): 357 | import serial 358 | import time 359 | ser = serial.Serial(ARDUINO_PORT) 360 | ser.setDTR(1) 361 | time.sleep(0.5) 362 | ser.setDTR(0) 363 | ser.close() 364 | 365 | if RST_TRIGGER: 366 | reset_cmd = '%s %s' % (RST_TRIGGER, ARDUINO_PORT) 367 | else: 368 | reset_cmd = pulseDTR 369 | 370 | # Upload 371 | UPLOAD_PROTOCOL = getBoardConf('upload.protocol') 372 | UPLOAD_SPEED = getBoardConf('upload.speed') 373 | 374 | if UPLOAD_PROTOCOL == 'stk500': 375 | UPLOAD_PROTOCOL = 'stk500v1' 376 | 377 | 378 | avrdudeOpts = ['-V', '-F', '-c %s' % UPLOAD_PROTOCOL, '-b %s' % UPLOAD_SPEED, 379 | '-p %s' % MCU, '-P %s' % ARDUINO_PORT, '-U flash:w:$SOURCES'] 380 | if AVRDUDE_CONF: 381 | avrdudeOpts.append('-C %s' % AVRDUDE_CONF) 382 | 383 | fuse_cmd = '%s %s' % (path.join(path.dirname(AVR_BIN_PREFIX), 'avrdude'), 384 | ' '.join(avrdudeOpts)) 385 | 386 | upload = envArduino.Alias('upload', TARGET + '.hex', [reset_cmd, fuse_cmd]) 387 | AlwaysBuild(upload) 388 | 389 | # Clean build directory 390 | envArduino.Clean('all', 'build/') 391 | 392 | # vim: et sw=4 fenc=utf-8: 393 | -------------------------------------------------------------------------------- /arduino_testsuite/examples/buildErrorTest/SConstruct: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | # scons script for the Arduino sketch 4 | # http://github.com/suapapa/arscons 5 | # 6 | # Copyright (C) 2010-2012 by Homin Lee 7 | # 8 | # This program is free software; you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation; either version 3 of the License, or 11 | # (at your option) any later version. 12 | 13 | # You'll need the serial module: http://pypi.python.org/pypi/pyserial 14 | 15 | # Basic Usage: 16 | # 1. make a folder which have same name of the sketch (ex. Blink/ for Blink.pde) 17 | # 2. put the sketch and SConstruct(this file) under the folder. 18 | # 3. to make the HEX. do following in the folder. 19 | # $ scons 20 | # 4. to upload the binary, do following in the folder. 21 | # $ scons upload 22 | 23 | # Thanks to: 24 | # * Ovidiu Predescu and Lee Pike 25 | # for Mac port and bugfix. 26 | # 27 | # This script tries to determine the port to which you have an Arduino 28 | # attached. If multiple USB serial devices are attached to your 29 | # computer, you'll need to explicitly specify the port to use, like 30 | # this: 31 | # 32 | # $ scons ARDUINO_PORT=/dev/ttyUSB0 33 | # 34 | # To add your own directory containing user libraries, pass EXTRA_LIB 35 | # to scons, like this: 36 | # 37 | # $ scons EXTRA_LIB= 38 | # 39 | 40 | from glob import glob 41 | from itertools import ifilter, imap 42 | from subprocess import check_call, CalledProcessError 43 | import sys 44 | import re 45 | import os 46 | from os import path 47 | from pprint import pprint 48 | 49 | env = Environment() 50 | platform = env['PLATFORM'] 51 | 52 | VARTAB = {} 53 | 54 | def resolve_var(varname, default_value): 55 | global VARTAB 56 | # precedence: scons argument -> environment variable -> default value 57 | ret = ARGUMENTS.get(varname, None) 58 | VARTAB[varname] = ('arg', ret) 59 | if ret == None: 60 | ret = os.environ.get(varname, None) 61 | VARTAB[varname] = ('env', ret) 62 | if ret == None: 63 | ret = default_value 64 | VARTAB[varname] = ('dfl', ret) 65 | return ret 66 | 67 | def getUsbTty(rx): 68 | usb_ttys = glob(rx) 69 | return usb_ttys[0] if len(usb_ttys) == 1 else None 70 | 71 | AVR_BIN_PREFIX = None 72 | AVRDUDE_CONF = None 73 | 74 | if platform == 'darwin': 75 | # For MacOS X, pick up the AVR tools from within Arduino.app 76 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', 77 | '/Applications/Arduino.app/Contents/Resources/Java') 78 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', getUsbTty('/dev/tty.usbserial*')) 79 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', '') 80 | AVR_HOME = resolve_var('AVR_HOME', 81 | path.join(ARDUINO_HOME, 'hardware/tools/avr/bin')) 82 | elif platform == 'win32': 83 | # For Windows, use environment variables. 84 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', None) 85 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', '') 86 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', '') 87 | if ARDUINO_HOME: 88 | AVR_HOME = resolve_var('AVR_HOME', 89 | path.join(ARDUINO_HOME, 'hardware/tools/avr/bin')) 90 | else: 91 | # For Ubuntu Linux (9.10 or higher) 92 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', '/usr/share/arduino/') 93 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', getUsbTty('/dev/ttyUSB*')) 94 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', 95 | path.expanduser('~/share/arduino/sketchbook/')) 96 | AVR_HOME = resolve_var('AVR_HOME', '') 97 | 98 | 99 | ARDUINO_BOARD = resolve_var('ARDUINO_BOARD', 'atmega328') 100 | ARDUINO_VER = resolve_var('ARDUINO_VER', 0) # Default to 0 if nothing is specified 101 | RST_TRIGGER = resolve_var('RST_TRIGGER', None) # use built-in pulseDTR() by default 102 | EXTRA_LIB = resolve_var('EXTRA_LIB', None) # handy for adding another arduino-lib dir 103 | 104 | pprint(VARTAB, indent = 4) 105 | 106 | if not ARDUINO_HOME: 107 | print 'ARDUINO_HOME must be defined.' 108 | raise KeyError('ARDUINO_HOME') 109 | 110 | ARDUINO_CONF = path.join(ARDUINO_HOME, 'hardware/arduino/boards.txt') 111 | # check given board name, ARDUINO_BOARD is valid one 112 | arduino_boards = path.join(ARDUINO_HOME,'hardware/*/boards.txt') 113 | custom_boards = path.join(SKETCHBOOK_HOME,'hardware/*/boards.txt') 114 | board_files = glob(arduino_boards) + glob(custom_boards) 115 | ptnBoard = re.compile(r'^([^#]*)\.name=(.*)') 116 | boards = {} 117 | for bf in board_files: 118 | for line in open(bf): 119 | result = ptnBoard.match(line) 120 | if result: 121 | boards[result.group(1)] = (result.group(2), bf) 122 | 123 | if ARDUINO_BOARD not in boards: 124 | print "ERROR! the given board name, %s is not in the supported board list:" % ARDUINO_BOARD 125 | print "all available board names are:" 126 | for name, description in boards.iteritems(): 127 | print "\t%s for %s" % (name.ljust(14), description[0]) 128 | #print "however, you may edit %s to add a new board." % ARDUINO_CONF 129 | sys.exit(-1) 130 | 131 | ARDUINO_CONF = boards[ARDUINO_BOARD][1] 132 | 133 | def getBoardConf(conf, default = None): 134 | for line in open(ARDUINO_CONF): 135 | line = line.strip() 136 | if '=' in line: 137 | key, value = line.split('=') 138 | if key == '.'.join([ARDUINO_BOARD, conf]): 139 | return value 140 | ret = default 141 | if ret == None: 142 | print "ERROR! can't find %s in %s" % (conf, ARDUINO_CONF) 143 | assert(False) 144 | return ret 145 | 146 | ARDUINO_CORE = path.join(ARDUINO_HOME, path.dirname(ARDUINO_CONF), 147 | 'cores/', getBoardConf('build.core', 'arduino')) 148 | ARDUINO_SKEL = path.join(ARDUINO_CORE, 'main.cpp') 149 | 150 | if ARDUINO_VER == 0: 151 | arduinoHeader = path.join(ARDUINO_CORE, 'Arduino.h') 152 | print "No Arduino version specified. Discovered version", 153 | if path.exists(arduinoHeader): 154 | print "100 or above" 155 | ARDUINO_VER = 100 156 | else: 157 | print "0023 or below" 158 | ARDUINO_VER = 23 159 | else: 160 | print "Arduino version " + ARDUINO_VER + " specified" 161 | 162 | # Some OSs need bundle with IDE tool-chain 163 | if platform == 'darwin' or platform == 'win32': 164 | AVRDUDE_CONF = path.join(ARDUINO_HOME, 'hardware/tools/avr/etc/avrdude.conf') 165 | 166 | AVR_BIN_PREFIX = path.join(AVR_HOME, 'avr-') 167 | 168 | ARDUINO_LIBS = [path.join(ARDUINO_HOME, 'libraries')] 169 | if EXTRA_LIB: 170 | ARDUINO_LIBS.append(EXTRA_LIB) 171 | if SKETCHBOOK_HOME: 172 | ARDUINO_LIBS.append(path.join(SKETCHBOOK_HOME, 'libraries')) 173 | 174 | 175 | # Override MCU and F_CPU 176 | MCU = ARGUMENTS.get('MCU', getBoardConf('build.mcu')) 177 | F_CPU = ARGUMENTS.get('F_CPU', getBoardConf('build.f_cpu')) 178 | 179 | # There should be a file with the same name as the folder and 180 | # with the extension .pde or .ino 181 | TARGET = path.basename(path.realpath(os.curdir)) 182 | assert(path.exists(TARGET + '.ino') or path.exists(TARGET + '.pde')) 183 | sketchExt = '.ino' if path.exists(TARGET + '.ino') else '.pde' 184 | 185 | cFlags = ['-ffunction-sections', '-fdata-sections', '-fno-exceptions', 186 | '-funsigned-char', '-funsigned-bitfields', '-fpack-struct', 187 | '-fshort-enums', '-Os', '-Wall', '-mmcu=%s' % MCU] 188 | envArduino = Environment(CC = AVR_BIN_PREFIX + 'gcc', 189 | CXX = AVR_BIN_PREFIX + 'g++', 190 | AS = AVR_BIN_PREFIX + 'gcc', 191 | CPPPATH = ['build/core'], 192 | CPPDEFINES = {'F_CPU': F_CPU, 'ARDUINO': ARDUINO_VER}, 193 | CFLAGS = cFlags + ['-std=gnu99'], 194 | CCFLAGS = cFlags, 195 | ASFLAGS = ['-assembler-with-cpp','-mmcu=%s' % MCU], 196 | TOOLS = ['gcc','g++', 'as']) 197 | 198 | hwVariant = path.join(ARDUINO_HOME, 'hardware/arduino/variants', 199 | getBoardConf("build.variant", "")) 200 | if hwVariant: 201 | envArduino.Append(CPPPATH = hwVariant) 202 | 203 | def run(cmd): 204 | """Run a command and decipher the return code. Exit by default.""" 205 | print ' '.join(cmd) 206 | try: 207 | check_call(cmd) 208 | except CalledProcessError as cpe: 209 | print "Error: return code: " + str(cpe.returncode) 210 | sys.exit(cpe.returncode) 211 | 212 | # WindowXP not supported path.samefile 213 | def sameFile(p1, p2): 214 | if platform == 'win32': 215 | ap1 = path.abspath(p1) 216 | ap2 = path.abspath(p2) 217 | return ap1 == ap2 218 | return path.samefile(p1, p2) 219 | 220 | def fnProcessing(target, source, env): 221 | wp = open(str(target[0]), 'wb') 222 | wp.write(open(ARDUINO_SKEL).read()) 223 | 224 | types='''void 225 | int char word long 226 | float double byte long 227 | boolean 228 | uint8_t uint16_t uint32_t 229 | int8_t int16_t int32_t''' 230 | types=' | '.join(types.split()) 231 | re_signature = re.compile(r"""^\s* ( 232 | (?: (%s) \s+ )? 233 | \w+ \s* 234 | \( \s* ((%s) \s+ \*? \w+ (?:\s*,\s*)? )* \) 235 | ) \s* {? \s* $""" % (types, types), re.MULTILINE | re.VERBOSE) 236 | 237 | prototypes = {} 238 | 239 | for file in glob(path.realpath(os.curdir) + "/*" + sketchExt): 240 | for line in open(file): 241 | result = re_signature.search(line) 242 | if result: 243 | prototypes[result.group(1)] = result.group(2) 244 | 245 | for name in prototypes.iterkeys(): 246 | print "%s;" % name 247 | wp.write("%s;\n" % name) 248 | 249 | for file in glob(path.realpath(os.curdir) + "/*" + sketchExt): 250 | print file, TARGET 251 | if not sameFile(file, TARGET + sketchExt): 252 | wp.write('#line 1 "%s"\r\n' % file) 253 | wp.write(open(file).read()) 254 | 255 | # Add this preprocessor directive to localize the errors. 256 | sourcePath = str(source[0]).replace('\\', '\\\\') 257 | wp.write('#line 1 "%s"\r\n' % sourcePath) 258 | wp.write(open(str(source[0])).read()) 259 | 260 | def fnCompressCore(target, source, env): 261 | core_prefix = 'build/core/'.replace('/', os.path.sep) 262 | core_files = (x for x in imap(str, source) 263 | if x.startswith(core_prefix)) 264 | for file in core_files: 265 | run([AVR_BIN_PREFIX + 'ar', 'rcs', str(target[0]), file]) 266 | 267 | bldProcessing = Builder(action = fnProcessing) #, suffix = '.cpp', src_suffix = sketchExt) 268 | bldCompressCore = Builder(action = fnCompressCore) 269 | bldELF = Builder(action = AVR_BIN_PREFIX + 'gcc -mmcu=%s ' % MCU + 270 | '-Os -Wl,--gc-sections -lm -o $TARGET $SOURCES -lc') 271 | bldHEX = Builder(action = AVR_BIN_PREFIX + 'objcopy -O ihex -R .eeprom $SOURCES $TARGET') 272 | 273 | envArduino.Append(BUILDERS = {'Processing' : bldProcessing}) 274 | envArduino.Append(BUILDERS = {'CompressCore': bldCompressCore}) 275 | envArduino.Append(BUILDERS = {'Elf' : bldELF}) 276 | envArduino.Append(BUILDERS = {'Hex' : bldHEX}) 277 | 278 | ptnSource = re.compile(r'\.(?:c(?:pp)?|S)$') 279 | def gatherSources(srcpath): 280 | return [path.join(srcpath, f) for f 281 | in os.listdir(srcpath) if ptnSource.search(f)] 282 | 283 | # add arduino core sources 284 | VariantDir('build/core', ARDUINO_CORE) 285 | core_sources = gatherSources(ARDUINO_CORE) 286 | core_sources = [x.replace(ARDUINO_CORE, 'build/core/') for x 287 | in core_sources if path.basename(x) != 'main.cpp'] 288 | 289 | # add libraries 290 | libCandidates = [] 291 | ptnLib = re.compile(r'^[ ]*#[ ]*include [<"](.*)\.h[>"]') 292 | for line in open(TARGET + sketchExt): 293 | result = ptnLib.search(line) 294 | if not result: 295 | continue 296 | # Look for the library directory that contains the header. 297 | filename = result.group(1) + '.h' 298 | for libdir in ARDUINO_LIBS: 299 | for root, dirs, files in os.walk(libdir, followlinks=True): 300 | if filename in files: 301 | libCandidates.append(path.basename(root)) 302 | 303 | # Hack. In version 20 of the Arduino IDE, the Ethernet library depends 304 | # implicitly on the SPI library. 305 | if ARDUINO_VER >= 20 and 'Ethernet' in libCandidates: 306 | libCandidates.append('SPI') 307 | 308 | all_libs_sources = [] 309 | for index, orig_lib_dir in enumerate(ARDUINO_LIBS): 310 | lib_dir = 'build/lib_%02d' % index 311 | VariantDir(lib_dir, orig_lib_dir) 312 | for libPath in ifilter(path.isdir, glob(path.join(orig_lib_dir, '*'))): 313 | libName = path.basename(libPath) 314 | if not libName in libCandidates: 315 | continue 316 | envArduino.Append(CPPPATH = libPath.replace(orig_lib_dir, lib_dir)) 317 | lib_sources = gatherSources(libPath) 318 | utilDir = path.join(libPath, 'utility') 319 | if path.exists(utilDir) and path.isdir(utilDir): 320 | lib_sources += gatherSources(utilDir) 321 | envArduino.Append(CPPPATH = utilDir.replace(orig_lib_dir, lib_dir)) 322 | lib_sources = (x.replace(orig_lib_dir, lib_dir) for x in lib_sources) 323 | all_libs_sources.extend(lib_sources) 324 | 325 | # Add raw sources which live in sketch dir. 326 | build_top = path.realpath('.') 327 | VariantDir('build/local/', build_top) 328 | local_sources = gatherSources(build_top) 329 | local_sources = [x.replace(build_top, 'build/local/') for x in local_sources] 330 | if local_sources: 331 | envArduino.Append(CPPPATH = 'build/local') 332 | 333 | # Convert sketch(.pde) to cpp 334 | envArduino.Processing('build/' + TARGET + '.cpp', 'build/' + TARGET + sketchExt) 335 | VariantDir('build', '.') 336 | 337 | sources = ['build/' + TARGET + '.cpp'] 338 | #sources += core_sources 339 | sources += local_sources 340 | sources += all_libs_sources 341 | 342 | # Finally Build!! 343 | core_objs = envArduino.Object(core_sources) 344 | objs = envArduino.Object(sources) #, LIBS=libs, LIBPATH='.') 345 | objs = objs + envArduino.CompressCore('build/core.a', core_objs) 346 | envArduino.Elf(TARGET + '.elf', objs) 347 | envArduino.Hex(TARGET + '.hex', TARGET + '.elf') 348 | 349 | # Print Size 350 | # TODO: check binary size 351 | MAX_SIZE = getBoardConf('upload.maximum_size') 352 | print "maximum size for hex file: %s bytes" % MAX_SIZE 353 | envArduino.Command(None, TARGET + '.hex', AVR_BIN_PREFIX + 'size --target=ihex $SOURCE') 354 | 355 | # Reset 356 | def pulseDTR(target, source, env): 357 | import serial 358 | import time 359 | ser = serial.Serial(ARDUINO_PORT) 360 | ser.setDTR(1) 361 | time.sleep(0.5) 362 | ser.setDTR(0) 363 | ser.close() 364 | 365 | if RST_TRIGGER: 366 | reset_cmd = '%s %s' % (RST_TRIGGER, ARDUINO_PORT) 367 | else: 368 | reset_cmd = pulseDTR 369 | 370 | # Upload 371 | UPLOAD_PROTOCOL = getBoardConf('upload.protocol') 372 | UPLOAD_SPEED = getBoardConf('upload.speed') 373 | 374 | if UPLOAD_PROTOCOL == 'stk500': 375 | UPLOAD_PROTOCOL = 'stk500v1' 376 | 377 | 378 | avrdudeOpts = ['-V', '-F', '-c %s' % UPLOAD_PROTOCOL, '-b %s' % UPLOAD_SPEED, 379 | '-p %s' % MCU, '-P %s' % ARDUINO_PORT, '-U flash:w:$SOURCES'] 380 | if AVRDUDE_CONF: 381 | avrdudeOpts.append('-C %s' % AVRDUDE_CONF) 382 | 383 | fuse_cmd = '%s %s' % (path.join(path.dirname(AVR_BIN_PREFIX), 'avrdude'), 384 | ' '.join(avrdudeOpts)) 385 | 386 | upload = envArduino.Alias('upload', TARGET + '.hex', [reset_cmd, fuse_cmd]) 387 | AlwaysBuild(upload) 388 | 389 | # Clean build directory 390 | envArduino.Clean('all', 'build/') 391 | 392 | # vim: et sw=4 fenc=utf-8: 393 | -------------------------------------------------------------------------------- /arduino_testsuite/examples/floatingPin/SConstruct: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | # scons script for the Arduino sketch 4 | # http://github.com/suapapa/arscons 5 | # 6 | # Copyright (C) 2010-2012 by Homin Lee 7 | # 8 | # This program is free software; you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation; either version 3 of the License, or 11 | # (at your option) any later version. 12 | 13 | # You'll need the serial module: http://pypi.python.org/pypi/pyserial 14 | 15 | # Basic Usage: 16 | # 1. make a folder which have same name of the sketch (ex. Blink/ for Blink.pde) 17 | # 2. put the sketch and SConstruct(this file) under the folder. 18 | # 3. to make the HEX. do following in the folder. 19 | # $ scons 20 | # 4. to upload the binary, do following in the folder. 21 | # $ scons upload 22 | 23 | # Thanks to: 24 | # * Ovidiu Predescu and Lee Pike 25 | # for Mac port and bugfix. 26 | # 27 | # This script tries to determine the port to which you have an Arduino 28 | # attached. If multiple USB serial devices are attached to your 29 | # computer, you'll need to explicitly specify the port to use, like 30 | # this: 31 | # 32 | # $ scons ARDUINO_PORT=/dev/ttyUSB0 33 | # 34 | # To add your own directory containing user libraries, pass EXTRA_LIB 35 | # to scons, like this: 36 | # 37 | # $ scons EXTRA_LIB= 38 | # 39 | 40 | from glob import glob 41 | from itertools import ifilter, imap 42 | from subprocess import check_call, CalledProcessError 43 | import sys 44 | import re 45 | import os 46 | from os import path 47 | from pprint import pprint 48 | 49 | env = Environment() 50 | platform = env['PLATFORM'] 51 | 52 | VARTAB = {} 53 | 54 | def resolve_var(varname, default_value): 55 | global VARTAB 56 | # precedence: scons argument -> environment variable -> default value 57 | ret = ARGUMENTS.get(varname, None) 58 | VARTAB[varname] = ('arg', ret) 59 | if ret == None: 60 | ret = os.environ.get(varname, None) 61 | VARTAB[varname] = ('env', ret) 62 | if ret == None: 63 | ret = default_value 64 | VARTAB[varname] = ('dfl', ret) 65 | return ret 66 | 67 | def getUsbTty(rx): 68 | usb_ttys = glob(rx) 69 | return usb_ttys[0] if len(usb_ttys) == 1 else None 70 | 71 | AVR_BIN_PREFIX = None 72 | AVRDUDE_CONF = None 73 | 74 | if platform == 'darwin': 75 | # For MacOS X, pick up the AVR tools from within Arduino.app 76 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', 77 | '/Applications/Arduino.app/Contents/Resources/Java') 78 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', getUsbTty('/dev/tty.usbserial*')) 79 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', '') 80 | AVR_HOME = resolve_var('AVR_HOME', 81 | path.join(ARDUINO_HOME, 'hardware/tools/avr/bin')) 82 | elif platform == 'win32': 83 | # For Windows, use environment variables. 84 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', None) 85 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', '') 86 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', '') 87 | if ARDUINO_HOME: 88 | AVR_HOME = resolve_var('AVR_HOME', 89 | path.join(ARDUINO_HOME, 'hardware/tools/avr/bin')) 90 | else: 91 | # For Ubuntu Linux (9.10 or higher) 92 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', '/usr/share/arduino/') 93 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', getUsbTty('/dev/ttyUSB*')) 94 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', 95 | path.expanduser('~/share/arduino/sketchbook/')) 96 | AVR_HOME = resolve_var('AVR_HOME', '') 97 | 98 | 99 | ARDUINO_BOARD = resolve_var('ARDUINO_BOARD', 'atmega328') 100 | ARDUINO_VER = resolve_var('ARDUINO_VER', 0) # Default to 0 if nothing is specified 101 | RST_TRIGGER = resolve_var('RST_TRIGGER', None) # use built-in pulseDTR() by default 102 | EXTRA_LIB = resolve_var('EXTRA_LIB', None) # handy for adding another arduino-lib dir 103 | 104 | pprint(VARTAB, indent = 4) 105 | 106 | if not ARDUINO_HOME: 107 | print 'ARDUINO_HOME must be defined.' 108 | raise KeyError('ARDUINO_HOME') 109 | 110 | ARDUINO_CONF = path.join(ARDUINO_HOME, 'hardware/arduino/boards.txt') 111 | # check given board name, ARDUINO_BOARD is valid one 112 | arduino_boards = path.join(ARDUINO_HOME,'hardware/*/boards.txt') 113 | custom_boards = path.join(SKETCHBOOK_HOME,'hardware/*/boards.txt') 114 | board_files = glob(arduino_boards) + glob(custom_boards) 115 | ptnBoard = re.compile(r'^([^#]*)\.name=(.*)') 116 | boards = {} 117 | for bf in board_files: 118 | for line in open(bf): 119 | result = ptnBoard.match(line) 120 | if result: 121 | boards[result.group(1)] = (result.group(2), bf) 122 | 123 | if ARDUINO_BOARD not in boards: 124 | print "ERROR! the given board name, %s is not in the supported board list:" % ARDUINO_BOARD 125 | print "all available board names are:" 126 | for name, description in boards.iteritems(): 127 | print "\t%s for %s" % (name.ljust(14), description[0]) 128 | #print "however, you may edit %s to add a new board." % ARDUINO_CONF 129 | sys.exit(-1) 130 | 131 | ARDUINO_CONF = boards[ARDUINO_BOARD][1] 132 | 133 | def getBoardConf(conf, default = None): 134 | for line in open(ARDUINO_CONF): 135 | line = line.strip() 136 | if '=' in line: 137 | key, value = line.split('=') 138 | if key == '.'.join([ARDUINO_BOARD, conf]): 139 | return value 140 | ret = default 141 | if ret == None: 142 | print "ERROR! can't find %s in %s" % (conf, ARDUINO_CONF) 143 | assert(False) 144 | return ret 145 | 146 | ARDUINO_CORE = path.join(ARDUINO_HOME, path.dirname(ARDUINO_CONF), 147 | 'cores/', getBoardConf('build.core', 'arduino')) 148 | ARDUINO_SKEL = path.join(ARDUINO_CORE, 'main.cpp') 149 | 150 | if ARDUINO_VER == 0: 151 | arduinoHeader = path.join(ARDUINO_CORE, 'Arduino.h') 152 | print "No Arduino version specified. Discovered version", 153 | if path.exists(arduinoHeader): 154 | print "100 or above" 155 | ARDUINO_VER = 100 156 | else: 157 | print "0023 or below" 158 | ARDUINO_VER = 23 159 | else: 160 | print "Arduino version " + ARDUINO_VER + " specified" 161 | 162 | # Some OSs need bundle with IDE tool-chain 163 | if platform == 'darwin' or platform == 'win32': 164 | AVRDUDE_CONF = path.join(ARDUINO_HOME, 'hardware/tools/avr/etc/avrdude.conf') 165 | 166 | AVR_BIN_PREFIX = path.join(AVR_HOME, 'avr-') 167 | 168 | ARDUINO_LIBS = [path.join(ARDUINO_HOME, 'libraries')] 169 | if EXTRA_LIB: 170 | ARDUINO_LIBS.append(EXTRA_LIB) 171 | if SKETCHBOOK_HOME: 172 | ARDUINO_LIBS.append(path.join(SKETCHBOOK_HOME, 'libraries')) 173 | 174 | 175 | # Override MCU and F_CPU 176 | MCU = ARGUMENTS.get('MCU', getBoardConf('build.mcu')) 177 | F_CPU = ARGUMENTS.get('F_CPU', getBoardConf('build.f_cpu')) 178 | 179 | # There should be a file with the same name as the folder and 180 | # with the extension .pde or .ino 181 | TARGET = path.basename(path.realpath(os.curdir)) 182 | assert(path.exists(TARGET + '.ino') or path.exists(TARGET + '.pde')) 183 | sketchExt = '.ino' if path.exists(TARGET + '.ino') else '.pde' 184 | 185 | cFlags = ['-ffunction-sections', '-fdata-sections', '-fno-exceptions', 186 | '-funsigned-char', '-funsigned-bitfields', '-fpack-struct', 187 | '-fshort-enums', '-Os', '-Wall', '-mmcu=%s' % MCU] 188 | envArduino = Environment(CC = AVR_BIN_PREFIX + 'gcc', 189 | CXX = AVR_BIN_PREFIX + 'g++', 190 | AS = AVR_BIN_PREFIX + 'gcc', 191 | CPPPATH = ['build/core'], 192 | CPPDEFINES = {'F_CPU': F_CPU, 'ARDUINO': ARDUINO_VER}, 193 | CFLAGS = cFlags + ['-std=gnu99'], 194 | CCFLAGS = cFlags, 195 | ASFLAGS = ['-assembler-with-cpp','-mmcu=%s' % MCU], 196 | TOOLS = ['gcc','g++', 'as']) 197 | 198 | hwVariant = path.join(ARDUINO_HOME, 'hardware/arduino/variants', 199 | getBoardConf("build.variant", "")) 200 | if hwVariant: 201 | envArduino.Append(CPPPATH = hwVariant) 202 | 203 | def run(cmd): 204 | """Run a command and decipher the return code. Exit by default.""" 205 | print ' '.join(cmd) 206 | try: 207 | check_call(cmd) 208 | except CalledProcessError as cpe: 209 | print "Error: return code: " + str(cpe.returncode) 210 | sys.exit(cpe.returncode) 211 | 212 | # WindowXP not supported path.samefile 213 | def sameFile(p1, p2): 214 | if platform == 'win32': 215 | ap1 = path.abspath(p1) 216 | ap2 = path.abspath(p2) 217 | return ap1 == ap2 218 | return path.samefile(p1, p2) 219 | 220 | def fnProcessing(target, source, env): 221 | wp = open(str(target[0]), 'wb') 222 | wp.write(open(ARDUINO_SKEL).read()) 223 | 224 | types='''void 225 | int char word long 226 | float double byte long 227 | boolean 228 | uint8_t uint16_t uint32_t 229 | int8_t int16_t int32_t''' 230 | types=' | '.join(types.split()) 231 | re_signature = re.compile(r"""^\s* ( 232 | (?: (%s) \s+ )? 233 | \w+ \s* 234 | \( \s* ((%s) \s+ \*? \w+ (?:\s*,\s*)? )* \) 235 | ) \s* {? \s* $""" % (types, types), re.MULTILINE | re.VERBOSE) 236 | 237 | prototypes = {} 238 | 239 | for file in glob(path.realpath(os.curdir) + "/*" + sketchExt): 240 | for line in open(file): 241 | result = re_signature.search(line) 242 | if result: 243 | prototypes[result.group(1)] = result.group(2) 244 | 245 | for name in prototypes.iterkeys(): 246 | print "%s;" % name 247 | wp.write("%s;\n" % name) 248 | 249 | for file in glob(path.realpath(os.curdir) + "/*" + sketchExt): 250 | print file, TARGET 251 | if not sameFile(file, TARGET + sketchExt): 252 | wp.write('#line 1 "%s"\r\n' % file) 253 | wp.write(open(file).read()) 254 | 255 | # Add this preprocessor directive to localize the errors. 256 | sourcePath = str(source[0]).replace('\\', '\\\\') 257 | wp.write('#line 1 "%s"\r\n' % sourcePath) 258 | wp.write(open(str(source[0])).read()) 259 | 260 | def fnCompressCore(target, source, env): 261 | core_prefix = 'build/core/'.replace('/', os.path.sep) 262 | core_files = (x for x in imap(str, source) 263 | if x.startswith(core_prefix)) 264 | for file in core_files: 265 | run([AVR_BIN_PREFIX + 'ar', 'rcs', str(target[0]), file]) 266 | 267 | bldProcessing = Builder(action = fnProcessing) #, suffix = '.cpp', src_suffix = sketchExt) 268 | bldCompressCore = Builder(action = fnCompressCore) 269 | bldELF = Builder(action = AVR_BIN_PREFIX + 'gcc -mmcu=%s ' % MCU + 270 | '-Os -Wl,--gc-sections -lm -o $TARGET $SOURCES -lc') 271 | bldHEX = Builder(action = AVR_BIN_PREFIX + 'objcopy -O ihex -R .eeprom $SOURCES $TARGET') 272 | 273 | envArduino.Append(BUILDERS = {'Processing' : bldProcessing}) 274 | envArduino.Append(BUILDERS = {'CompressCore': bldCompressCore}) 275 | envArduino.Append(BUILDERS = {'Elf' : bldELF}) 276 | envArduino.Append(BUILDERS = {'Hex' : bldHEX}) 277 | 278 | ptnSource = re.compile(r'\.(?:c(?:pp)?|S)$') 279 | def gatherSources(srcpath): 280 | return [path.join(srcpath, f) for f 281 | in os.listdir(srcpath) if ptnSource.search(f)] 282 | 283 | # add arduino core sources 284 | VariantDir('build/core', ARDUINO_CORE) 285 | core_sources = gatherSources(ARDUINO_CORE) 286 | core_sources = [x.replace(ARDUINO_CORE, 'build/core/') for x 287 | in core_sources if path.basename(x) != 'main.cpp'] 288 | 289 | # add libraries 290 | libCandidates = [] 291 | ptnLib = re.compile(r'^[ ]*#[ ]*include [<"](.*)\.h[>"]') 292 | for line in open(TARGET + sketchExt): 293 | result = ptnLib.search(line) 294 | if not result: 295 | continue 296 | # Look for the library directory that contains the header. 297 | filename = result.group(1) + '.h' 298 | for libdir in ARDUINO_LIBS: 299 | for root, dirs, files in os.walk(libdir, followlinks=True): 300 | if filename in files: 301 | libCandidates.append(path.basename(root)) 302 | 303 | # Hack. In version 20 of the Arduino IDE, the Ethernet library depends 304 | # implicitly on the SPI library. 305 | if ARDUINO_VER >= 20 and 'Ethernet' in libCandidates: 306 | libCandidates.append('SPI') 307 | 308 | all_libs_sources = [] 309 | for index, orig_lib_dir in enumerate(ARDUINO_LIBS): 310 | lib_dir = 'build/lib_%02d' % index 311 | VariantDir(lib_dir, orig_lib_dir) 312 | for libPath in ifilter(path.isdir, glob(path.join(orig_lib_dir, '*'))): 313 | libName = path.basename(libPath) 314 | if not libName in libCandidates: 315 | continue 316 | envArduino.Append(CPPPATH = libPath.replace(orig_lib_dir, lib_dir)) 317 | lib_sources = gatherSources(libPath) 318 | utilDir = path.join(libPath, 'utility') 319 | if path.exists(utilDir) and path.isdir(utilDir): 320 | lib_sources += gatherSources(utilDir) 321 | envArduino.Append(CPPPATH = utilDir.replace(orig_lib_dir, lib_dir)) 322 | lib_sources = (x.replace(orig_lib_dir, lib_dir) for x in lib_sources) 323 | all_libs_sources.extend(lib_sources) 324 | 325 | # Add raw sources which live in sketch dir. 326 | build_top = path.realpath('.') 327 | VariantDir('build/local/', build_top) 328 | local_sources = gatherSources(build_top) 329 | local_sources = [x.replace(build_top, 'build/local/') for x in local_sources] 330 | if local_sources: 331 | envArduino.Append(CPPPATH = 'build/local') 332 | 333 | # Convert sketch(.pde) to cpp 334 | envArduino.Processing('build/' + TARGET + '.cpp', 'build/' + TARGET + sketchExt) 335 | VariantDir('build', '.') 336 | 337 | sources = ['build/' + TARGET + '.cpp'] 338 | #sources += core_sources 339 | sources += local_sources 340 | sources += all_libs_sources 341 | 342 | # Finally Build!! 343 | core_objs = envArduino.Object(core_sources) 344 | objs = envArduino.Object(sources) #, LIBS=libs, LIBPATH='.') 345 | objs = objs + envArduino.CompressCore('build/core.a', core_objs) 346 | envArduino.Elf(TARGET + '.elf', objs) 347 | envArduino.Hex(TARGET + '.hex', TARGET + '.elf') 348 | 349 | # Print Size 350 | # TODO: check binary size 351 | MAX_SIZE = getBoardConf('upload.maximum_size') 352 | print "maximum size for hex file: %s bytes" % MAX_SIZE 353 | envArduino.Command(None, TARGET + '.hex', AVR_BIN_PREFIX + 'size --target=ihex $SOURCE') 354 | 355 | # Reset 356 | def pulseDTR(target, source, env): 357 | import serial 358 | import time 359 | ser = serial.Serial(ARDUINO_PORT) 360 | ser.setDTR(1) 361 | time.sleep(0.5) 362 | ser.setDTR(0) 363 | ser.close() 364 | 365 | if RST_TRIGGER: 366 | reset_cmd = '%s %s' % (RST_TRIGGER, ARDUINO_PORT) 367 | else: 368 | reset_cmd = pulseDTR 369 | 370 | # Upload 371 | UPLOAD_PROTOCOL = getBoardConf('upload.protocol') 372 | UPLOAD_SPEED = getBoardConf('upload.speed') 373 | 374 | if UPLOAD_PROTOCOL == 'stk500': 375 | UPLOAD_PROTOCOL = 'stk500v1' 376 | 377 | 378 | avrdudeOpts = ['-V', '-F', '-c %s' % UPLOAD_PROTOCOL, '-b %s' % UPLOAD_SPEED, 379 | '-p %s' % MCU, '-P %s' % ARDUINO_PORT, '-U flash:w:$SOURCES'] 380 | if AVRDUDE_CONF: 381 | avrdudeOpts.append('-C %s' % AVRDUDE_CONF) 382 | 383 | fuse_cmd = '%s %s' % (path.join(path.dirname(AVR_BIN_PREFIX), 'avrdude'), 384 | ' '.join(avrdudeOpts)) 385 | 386 | upload = envArduino.Alias('upload', TARGET + '.hex', [reset_cmd, fuse_cmd]) 387 | AlwaysBuild(upload) 388 | 389 | # Clean build directory 390 | envArduino.Clean('all', 'build/') 391 | 392 | # vim: et sw=4 fenc=utf-8: 393 | -------------------------------------------------------------------------------- /arduino_testsuite/examples/inInterval/SConstruct: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | # scons script for the Arduino sketch 4 | # http://github.com/suapapa/arscons 5 | # 6 | # Copyright (C) 2010-2012 by Homin Lee 7 | # 8 | # This program is free software; you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation; either version 3 of the License, or 11 | # (at your option) any later version. 12 | 13 | # You'll need the serial module: http://pypi.python.org/pypi/pyserial 14 | 15 | # Basic Usage: 16 | # 1. make a folder which have same name of the sketch (ex. Blink/ for Blink.pde) 17 | # 2. put the sketch and SConstruct(this file) under the folder. 18 | # 3. to make the HEX. do following in the folder. 19 | # $ scons 20 | # 4. to upload the binary, do following in the folder. 21 | # $ scons upload 22 | 23 | # Thanks to: 24 | # * Ovidiu Predescu and Lee Pike 25 | # for Mac port and bugfix. 26 | # 27 | # This script tries to determine the port to which you have an Arduino 28 | # attached. If multiple USB serial devices are attached to your 29 | # computer, you'll need to explicitly specify the port to use, like 30 | # this: 31 | # 32 | # $ scons ARDUINO_PORT=/dev/ttyUSB0 33 | # 34 | # To add your own directory containing user libraries, pass EXTRA_LIB 35 | # to scons, like this: 36 | # 37 | # $ scons EXTRA_LIB= 38 | # 39 | 40 | from glob import glob 41 | from itertools import ifilter, imap 42 | from subprocess import check_call, CalledProcessError 43 | import sys 44 | import re 45 | import os 46 | from os import path 47 | from pprint import pprint 48 | 49 | env = Environment() 50 | platform = env['PLATFORM'] 51 | 52 | VARTAB = {} 53 | 54 | def resolve_var(varname, default_value): 55 | global VARTAB 56 | # precedence: scons argument -> environment variable -> default value 57 | ret = ARGUMENTS.get(varname, None) 58 | VARTAB[varname] = ('arg', ret) 59 | if ret == None: 60 | ret = os.environ.get(varname, None) 61 | VARTAB[varname] = ('env', ret) 62 | if ret == None: 63 | ret = default_value 64 | VARTAB[varname] = ('dfl', ret) 65 | return ret 66 | 67 | def getUsbTty(rx): 68 | usb_ttys = glob(rx) 69 | return usb_ttys[0] if len(usb_ttys) == 1 else None 70 | 71 | AVR_BIN_PREFIX = None 72 | AVRDUDE_CONF = None 73 | 74 | if platform == 'darwin': 75 | # For MacOS X, pick up the AVR tools from within Arduino.app 76 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', 77 | '/Applications/Arduino.app/Contents/Resources/Java') 78 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', getUsbTty('/dev/tty.usbserial*')) 79 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', '') 80 | AVR_HOME = resolve_var('AVR_HOME', 81 | path.join(ARDUINO_HOME, 'hardware/tools/avr/bin')) 82 | elif platform == 'win32': 83 | # For Windows, use environment variables. 84 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', None) 85 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', '') 86 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', '') 87 | if ARDUINO_HOME: 88 | AVR_HOME = resolve_var('AVR_HOME', 89 | path.join(ARDUINO_HOME, 'hardware/tools/avr/bin')) 90 | else: 91 | # For Ubuntu Linux (9.10 or higher) 92 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', '/usr/share/arduino/') 93 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', getUsbTty('/dev/ttyUSB*')) 94 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', 95 | path.expanduser('~/share/arduino/sketchbook/')) 96 | AVR_HOME = resolve_var('AVR_HOME', '') 97 | 98 | 99 | ARDUINO_BOARD = resolve_var('ARDUINO_BOARD', 'atmega328') 100 | ARDUINO_VER = resolve_var('ARDUINO_VER', 0) # Default to 0 if nothing is specified 101 | RST_TRIGGER = resolve_var('RST_TRIGGER', None) # use built-in pulseDTR() by default 102 | EXTRA_LIB = resolve_var('EXTRA_LIB', None) # handy for adding another arduino-lib dir 103 | 104 | pprint(VARTAB, indent = 4) 105 | 106 | if not ARDUINO_HOME: 107 | print 'ARDUINO_HOME must be defined.' 108 | raise KeyError('ARDUINO_HOME') 109 | 110 | ARDUINO_CONF = path.join(ARDUINO_HOME, 'hardware/arduino/boards.txt') 111 | # check given board name, ARDUINO_BOARD is valid one 112 | arduino_boards = path.join(ARDUINO_HOME,'hardware/*/boards.txt') 113 | custom_boards = path.join(SKETCHBOOK_HOME,'hardware/*/boards.txt') 114 | board_files = glob(arduino_boards) + glob(custom_boards) 115 | ptnBoard = re.compile(r'^([^#]*)\.name=(.*)') 116 | boards = {} 117 | for bf in board_files: 118 | for line in open(bf): 119 | result = ptnBoard.match(line) 120 | if result: 121 | boards[result.group(1)] = (result.group(2), bf) 122 | 123 | if ARDUINO_BOARD not in boards: 124 | print "ERROR! the given board name, %s is not in the supported board list:" % ARDUINO_BOARD 125 | print "all available board names are:" 126 | for name, description in boards.iteritems(): 127 | print "\t%s for %s" % (name.ljust(14), description[0]) 128 | #print "however, you may edit %s to add a new board." % ARDUINO_CONF 129 | sys.exit(-1) 130 | 131 | ARDUINO_CONF = boards[ARDUINO_BOARD][1] 132 | 133 | def getBoardConf(conf, default = None): 134 | for line in open(ARDUINO_CONF): 135 | line = line.strip() 136 | if '=' in line: 137 | key, value = line.split('=') 138 | if key == '.'.join([ARDUINO_BOARD, conf]): 139 | return value 140 | ret = default 141 | if ret == None: 142 | print "ERROR! can't find %s in %s" % (conf, ARDUINO_CONF) 143 | assert(False) 144 | return ret 145 | 146 | ARDUINO_CORE = path.join(ARDUINO_HOME, path.dirname(ARDUINO_CONF), 147 | 'cores/', getBoardConf('build.core', 'arduino')) 148 | ARDUINO_SKEL = path.join(ARDUINO_CORE, 'main.cpp') 149 | 150 | if ARDUINO_VER == 0: 151 | arduinoHeader = path.join(ARDUINO_CORE, 'Arduino.h') 152 | print "No Arduino version specified. Discovered version", 153 | if path.exists(arduinoHeader): 154 | print "100 or above" 155 | ARDUINO_VER = 100 156 | else: 157 | print "0023 or below" 158 | ARDUINO_VER = 23 159 | else: 160 | print "Arduino version " + ARDUINO_VER + " specified" 161 | 162 | # Some OSs need bundle with IDE tool-chain 163 | if platform == 'darwin' or platform == 'win32': 164 | AVRDUDE_CONF = path.join(ARDUINO_HOME, 'hardware/tools/avr/etc/avrdude.conf') 165 | 166 | AVR_BIN_PREFIX = path.join(AVR_HOME, 'avr-') 167 | 168 | ARDUINO_LIBS = [path.join(ARDUINO_HOME, 'libraries')] 169 | if EXTRA_LIB: 170 | ARDUINO_LIBS.append(EXTRA_LIB) 171 | if SKETCHBOOK_HOME: 172 | ARDUINO_LIBS.append(path.join(SKETCHBOOK_HOME, 'libraries')) 173 | 174 | 175 | # Override MCU and F_CPU 176 | MCU = ARGUMENTS.get('MCU', getBoardConf('build.mcu')) 177 | F_CPU = ARGUMENTS.get('F_CPU', getBoardConf('build.f_cpu')) 178 | 179 | # There should be a file with the same name as the folder and 180 | # with the extension .pde or .ino 181 | TARGET = path.basename(path.realpath(os.curdir)) 182 | assert(path.exists(TARGET + '.ino') or path.exists(TARGET + '.pde')) 183 | sketchExt = '.ino' if path.exists(TARGET + '.ino') else '.pde' 184 | 185 | cFlags = ['-ffunction-sections', '-fdata-sections', '-fno-exceptions', 186 | '-funsigned-char', '-funsigned-bitfields', '-fpack-struct', 187 | '-fshort-enums', '-Os', '-Wall', '-mmcu=%s' % MCU] 188 | envArduino = Environment(CC = AVR_BIN_PREFIX + 'gcc', 189 | CXX = AVR_BIN_PREFIX + 'g++', 190 | AS = AVR_BIN_PREFIX + 'gcc', 191 | CPPPATH = ['build/core'], 192 | CPPDEFINES = {'F_CPU': F_CPU, 'ARDUINO': ARDUINO_VER}, 193 | CFLAGS = cFlags + ['-std=gnu99'], 194 | CCFLAGS = cFlags, 195 | ASFLAGS = ['-assembler-with-cpp','-mmcu=%s' % MCU], 196 | TOOLS = ['gcc','g++', 'as']) 197 | 198 | hwVariant = path.join(ARDUINO_HOME, 'hardware/arduino/variants', 199 | getBoardConf("build.variant", "")) 200 | if hwVariant: 201 | envArduino.Append(CPPPATH = hwVariant) 202 | 203 | def run(cmd): 204 | """Run a command and decipher the return code. Exit by default.""" 205 | print ' '.join(cmd) 206 | try: 207 | check_call(cmd) 208 | except CalledProcessError as cpe: 209 | print "Error: return code: " + str(cpe.returncode) 210 | sys.exit(cpe.returncode) 211 | 212 | # WindowXP not supported path.samefile 213 | def sameFile(p1, p2): 214 | if platform == 'win32': 215 | ap1 = path.abspath(p1) 216 | ap2 = path.abspath(p2) 217 | return ap1 == ap2 218 | return path.samefile(p1, p2) 219 | 220 | def fnProcessing(target, source, env): 221 | wp = open(str(target[0]), 'wb') 222 | wp.write(open(ARDUINO_SKEL).read()) 223 | 224 | types='''void 225 | int char word long 226 | float double byte long 227 | boolean 228 | uint8_t uint16_t uint32_t 229 | int8_t int16_t int32_t''' 230 | types=' | '.join(types.split()) 231 | re_signature = re.compile(r"""^\s* ( 232 | (?: (%s) \s+ )? 233 | \w+ \s* 234 | \( \s* ((%s) \s+ \*? \w+ (?:\s*,\s*)? )* \) 235 | ) \s* {? \s* $""" % (types, types), re.MULTILINE | re.VERBOSE) 236 | 237 | prototypes = {} 238 | 239 | for file in glob(path.realpath(os.curdir) + "/*" + sketchExt): 240 | for line in open(file): 241 | result = re_signature.search(line) 242 | if result: 243 | prototypes[result.group(1)] = result.group(2) 244 | 245 | for name in prototypes.iterkeys(): 246 | print "%s;" % name 247 | wp.write("%s;\n" % name) 248 | 249 | for file in glob(path.realpath(os.curdir) + "/*" + sketchExt): 250 | print file, TARGET 251 | if not sameFile(file, TARGET + sketchExt): 252 | wp.write('#line 1 "%s"\r\n' % file) 253 | wp.write(open(file).read()) 254 | 255 | # Add this preprocessor directive to localize the errors. 256 | sourcePath = str(source[0]).replace('\\', '\\\\') 257 | wp.write('#line 1 "%s"\r\n' % sourcePath) 258 | wp.write(open(str(source[0])).read()) 259 | 260 | def fnCompressCore(target, source, env): 261 | core_prefix = 'build/core/'.replace('/', os.path.sep) 262 | core_files = (x for x in imap(str, source) 263 | if x.startswith(core_prefix)) 264 | for file in core_files: 265 | run([AVR_BIN_PREFIX + 'ar', 'rcs', str(target[0]), file]) 266 | 267 | bldProcessing = Builder(action = fnProcessing) #, suffix = '.cpp', src_suffix = sketchExt) 268 | bldCompressCore = Builder(action = fnCompressCore) 269 | bldELF = Builder(action = AVR_BIN_PREFIX + 'gcc -mmcu=%s ' % MCU + 270 | '-Os -Wl,--gc-sections -lm -o $TARGET $SOURCES -lc') 271 | bldHEX = Builder(action = AVR_BIN_PREFIX + 'objcopy -O ihex -R .eeprom $SOURCES $TARGET') 272 | 273 | envArduino.Append(BUILDERS = {'Processing' : bldProcessing}) 274 | envArduino.Append(BUILDERS = {'CompressCore': bldCompressCore}) 275 | envArduino.Append(BUILDERS = {'Elf' : bldELF}) 276 | envArduino.Append(BUILDERS = {'Hex' : bldHEX}) 277 | 278 | ptnSource = re.compile(r'\.(?:c(?:pp)?|S)$') 279 | def gatherSources(srcpath): 280 | return [path.join(srcpath, f) for f 281 | in os.listdir(srcpath) if ptnSource.search(f)] 282 | 283 | # add arduino core sources 284 | VariantDir('build/core', ARDUINO_CORE) 285 | core_sources = gatherSources(ARDUINO_CORE) 286 | core_sources = [x.replace(ARDUINO_CORE, 'build/core/') for x 287 | in core_sources if path.basename(x) != 'main.cpp'] 288 | 289 | # add libraries 290 | libCandidates = [] 291 | ptnLib = re.compile(r'^[ ]*#[ ]*include [<"](.*)\.h[>"]') 292 | for line in open(TARGET + sketchExt): 293 | result = ptnLib.search(line) 294 | if not result: 295 | continue 296 | # Look for the library directory that contains the header. 297 | filename = result.group(1) + '.h' 298 | for libdir in ARDUINO_LIBS: 299 | for root, dirs, files in os.walk(libdir, followlinks=True): 300 | if filename in files: 301 | libCandidates.append(path.basename(root)) 302 | 303 | # Hack. In version 20 of the Arduino IDE, the Ethernet library depends 304 | # implicitly on the SPI library. 305 | if ARDUINO_VER >= 20 and 'Ethernet' in libCandidates: 306 | libCandidates.append('SPI') 307 | 308 | all_libs_sources = [] 309 | for index, orig_lib_dir in enumerate(ARDUINO_LIBS): 310 | lib_dir = 'build/lib_%02d' % index 311 | VariantDir(lib_dir, orig_lib_dir) 312 | for libPath in ifilter(path.isdir, glob(path.join(orig_lib_dir, '*'))): 313 | libName = path.basename(libPath) 314 | if not libName in libCandidates: 315 | continue 316 | envArduino.Append(CPPPATH = libPath.replace(orig_lib_dir, lib_dir)) 317 | lib_sources = gatherSources(libPath) 318 | utilDir = path.join(libPath, 'utility') 319 | if path.exists(utilDir) and path.isdir(utilDir): 320 | lib_sources += gatherSources(utilDir) 321 | envArduino.Append(CPPPATH = utilDir.replace(orig_lib_dir, lib_dir)) 322 | lib_sources = (x.replace(orig_lib_dir, lib_dir) for x in lib_sources) 323 | all_libs_sources.extend(lib_sources) 324 | 325 | # Add raw sources which live in sketch dir. 326 | build_top = path.realpath('.') 327 | VariantDir('build/local/', build_top) 328 | local_sources = gatherSources(build_top) 329 | local_sources = [x.replace(build_top, 'build/local/') for x in local_sources] 330 | if local_sources: 331 | envArduino.Append(CPPPATH = 'build/local') 332 | 333 | # Convert sketch(.pde) to cpp 334 | envArduino.Processing('build/' + TARGET + '.cpp', 'build/' + TARGET + sketchExt) 335 | VariantDir('build', '.') 336 | 337 | sources = ['build/' + TARGET + '.cpp'] 338 | #sources += core_sources 339 | sources += local_sources 340 | sources += all_libs_sources 341 | 342 | # Finally Build!! 343 | core_objs = envArduino.Object(core_sources) 344 | objs = envArduino.Object(sources) #, LIBS=libs, LIBPATH='.') 345 | objs = objs + envArduino.CompressCore('build/core.a', core_objs) 346 | envArduino.Elf(TARGET + '.elf', objs) 347 | envArduino.Hex(TARGET + '.hex', TARGET + '.elf') 348 | 349 | # Print Size 350 | # TODO: check binary size 351 | MAX_SIZE = getBoardConf('upload.maximum_size') 352 | print "maximum size for hex file: %s bytes" % MAX_SIZE 353 | envArduino.Command(None, TARGET + '.hex', AVR_BIN_PREFIX + 'size --target=ihex $SOURCE') 354 | 355 | # Reset 356 | def pulseDTR(target, source, env): 357 | import serial 358 | import time 359 | ser = serial.Serial(ARDUINO_PORT) 360 | ser.setDTR(1) 361 | time.sleep(0.5) 362 | ser.setDTR(0) 363 | ser.close() 364 | 365 | if RST_TRIGGER: 366 | reset_cmd = '%s %s' % (RST_TRIGGER, ARDUINO_PORT) 367 | else: 368 | reset_cmd = pulseDTR 369 | 370 | # Upload 371 | UPLOAD_PROTOCOL = getBoardConf('upload.protocol') 372 | UPLOAD_SPEED = getBoardConf('upload.speed') 373 | 374 | if UPLOAD_PROTOCOL == 'stk500': 375 | UPLOAD_PROTOCOL = 'stk500v1' 376 | 377 | 378 | avrdudeOpts = ['-V', '-F', '-c %s' % UPLOAD_PROTOCOL, '-b %s' % UPLOAD_SPEED, 379 | '-p %s' % MCU, '-P %s' % ARDUINO_PORT, '-U flash:w:$SOURCES'] 380 | if AVRDUDE_CONF: 381 | avrdudeOpts.append('-C %s' % AVRDUDE_CONF) 382 | 383 | fuse_cmd = '%s %s' % (path.join(path.dirname(AVR_BIN_PREFIX), 'avrdude'), 384 | ' '.join(avrdudeOpts)) 385 | 386 | upload = envArduino.Alias('upload', TARGET + '.hex', [reset_cmd, fuse_cmd]) 387 | AlwaysBuild(upload) 388 | 389 | # Clean build directory 390 | envArduino.Clean('all', 'build/') 391 | 392 | # vim: et sw=4 fenc=utf-8: 393 | -------------------------------------------------------------------------------- /arduino_testsuite/examples/simpleTest/SConstruct: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | # scons script for the Arduino sketch 4 | # http://github.com/suapapa/arscons 5 | # 6 | # Copyright (C) 2010-2012 by Homin Lee 7 | # 8 | # This program is free software; you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation; either version 3 of the License, or 11 | # (at your option) any later version. 12 | 13 | # You'll need the serial module: http://pypi.python.org/pypi/pyserial 14 | 15 | # Basic Usage: 16 | # 1. make a folder which have same name of the sketch (ex. Blink/ for Blink.pde) 17 | # 2. put the sketch and SConstruct(this file) under the folder. 18 | # 3. to make the HEX. do following in the folder. 19 | # $ scons 20 | # 4. to upload the binary, do following in the folder. 21 | # $ scons upload 22 | 23 | # Thanks to: 24 | # * Ovidiu Predescu and Lee Pike 25 | # for Mac port and bugfix. 26 | # 27 | # This script tries to determine the port to which you have an Arduino 28 | # attached. If multiple USB serial devices are attached to your 29 | # computer, you'll need to explicitly specify the port to use, like 30 | # this: 31 | # 32 | # $ scons ARDUINO_PORT=/dev/ttyUSB0 33 | # 34 | # To add your own directory containing user libraries, pass EXTRA_LIB 35 | # to scons, like this: 36 | # 37 | # $ scons EXTRA_LIB= 38 | # 39 | 40 | from glob import glob 41 | from itertools import ifilter, imap 42 | from subprocess import check_call, CalledProcessError 43 | import sys 44 | import re 45 | import os 46 | from os import path 47 | from pprint import pprint 48 | 49 | env = Environment() 50 | platform = env['PLATFORM'] 51 | 52 | VARTAB = {} 53 | 54 | def resolve_var(varname, default_value): 55 | global VARTAB 56 | # precedence: scons argument -> environment variable -> default value 57 | ret = ARGUMENTS.get(varname, None) 58 | VARTAB[varname] = ('arg', ret) 59 | if ret == None: 60 | ret = os.environ.get(varname, None) 61 | VARTAB[varname] = ('env', ret) 62 | if ret == None: 63 | ret = default_value 64 | VARTAB[varname] = ('dfl', ret) 65 | return ret 66 | 67 | def getUsbTty(rx): 68 | usb_ttys = glob(rx) 69 | return usb_ttys[0] if len(usb_ttys) == 1 else None 70 | 71 | AVR_BIN_PREFIX = None 72 | AVRDUDE_CONF = None 73 | 74 | if platform == 'darwin': 75 | # For MacOS X, pick up the AVR tools from within Arduino.app 76 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', 77 | '/Applications/Arduino.app/Contents/Resources/Java') 78 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', getUsbTty('/dev/tty.usbserial*')) 79 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', '') 80 | AVR_HOME = resolve_var('AVR_HOME', 81 | path.join(ARDUINO_HOME, 'hardware/tools/avr/bin')) 82 | elif platform == 'win32': 83 | # For Windows, use environment variables. 84 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', None) 85 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', '') 86 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', '') 87 | if ARDUINO_HOME: 88 | AVR_HOME = resolve_var('AVR_HOME', 89 | path.join(ARDUINO_HOME, 'hardware/tools/avr/bin')) 90 | else: 91 | # For Ubuntu Linux (9.10 or higher) 92 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', '/usr/share/arduino/') 93 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', getUsbTty('/dev/ttyUSB*')) 94 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', 95 | path.expanduser('~/share/arduino/sketchbook/')) 96 | AVR_HOME = resolve_var('AVR_HOME', '') 97 | 98 | 99 | ARDUINO_BOARD = resolve_var('ARDUINO_BOARD', 'atmega328') 100 | ARDUINO_VER = resolve_var('ARDUINO_VER', 0) # Default to 0 if nothing is specified 101 | RST_TRIGGER = resolve_var('RST_TRIGGER', None) # use built-in pulseDTR() by default 102 | EXTRA_LIB = resolve_var('EXTRA_LIB', None) # handy for adding another arduino-lib dir 103 | 104 | pprint(VARTAB, indent = 4) 105 | 106 | if not ARDUINO_HOME: 107 | print 'ARDUINO_HOME must be defined.' 108 | raise KeyError('ARDUINO_HOME') 109 | 110 | ARDUINO_CONF = path.join(ARDUINO_HOME, 'hardware/arduino/boards.txt') 111 | # check given board name, ARDUINO_BOARD is valid one 112 | arduino_boards = path.join(ARDUINO_HOME,'hardware/*/boards.txt') 113 | custom_boards = path.join(SKETCHBOOK_HOME,'hardware/*/boards.txt') 114 | board_files = glob(arduino_boards) + glob(custom_boards) 115 | ptnBoard = re.compile(r'^([^#]*)\.name=(.*)') 116 | boards = {} 117 | for bf in board_files: 118 | for line in open(bf): 119 | result = ptnBoard.match(line) 120 | if result: 121 | boards[result.group(1)] = (result.group(2), bf) 122 | 123 | if ARDUINO_BOARD not in boards: 124 | print "ERROR! the given board name, %s is not in the supported board list:" % ARDUINO_BOARD 125 | print "all available board names are:" 126 | for name, description in boards.iteritems(): 127 | print "\t%s for %s" % (name.ljust(14), description[0]) 128 | #print "however, you may edit %s to add a new board." % ARDUINO_CONF 129 | sys.exit(-1) 130 | 131 | ARDUINO_CONF = boards[ARDUINO_BOARD][1] 132 | 133 | def getBoardConf(conf, default = None): 134 | for line in open(ARDUINO_CONF): 135 | line = line.strip() 136 | if '=' in line: 137 | key, value = line.split('=') 138 | if key == '.'.join([ARDUINO_BOARD, conf]): 139 | return value 140 | ret = default 141 | if ret == None: 142 | print "ERROR! can't find %s in %s" % (conf, ARDUINO_CONF) 143 | assert(False) 144 | return ret 145 | 146 | ARDUINO_CORE = path.join(ARDUINO_HOME, path.dirname(ARDUINO_CONF), 147 | 'cores/', getBoardConf('build.core', 'arduino')) 148 | ARDUINO_SKEL = path.join(ARDUINO_CORE, 'main.cpp') 149 | 150 | if ARDUINO_VER == 0: 151 | arduinoHeader = path.join(ARDUINO_CORE, 'Arduino.h') 152 | print "No Arduino version specified. Discovered version", 153 | if path.exists(arduinoHeader): 154 | print "100 or above" 155 | ARDUINO_VER = 100 156 | else: 157 | print "0023 or below" 158 | ARDUINO_VER = 23 159 | else: 160 | print "Arduino version " + ARDUINO_VER + " specified" 161 | 162 | # Some OSs need bundle with IDE tool-chain 163 | if platform == 'darwin' or platform == 'win32': 164 | AVRDUDE_CONF = path.join(ARDUINO_HOME, 'hardware/tools/avr/etc/avrdude.conf') 165 | 166 | AVR_BIN_PREFIX = path.join(AVR_HOME, 'avr-') 167 | 168 | ARDUINO_LIBS = [path.join(ARDUINO_HOME, 'libraries')] 169 | if EXTRA_LIB: 170 | ARDUINO_LIBS.append(EXTRA_LIB) 171 | if SKETCHBOOK_HOME: 172 | ARDUINO_LIBS.append(path.join(SKETCHBOOK_HOME, 'libraries')) 173 | 174 | 175 | # Override MCU and F_CPU 176 | MCU = ARGUMENTS.get('MCU', getBoardConf('build.mcu')) 177 | F_CPU = ARGUMENTS.get('F_CPU', getBoardConf('build.f_cpu')) 178 | 179 | # There should be a file with the same name as the folder and 180 | # with the extension .pde or .ino 181 | TARGET = path.basename(path.realpath(os.curdir)) 182 | assert(path.exists(TARGET + '.ino') or path.exists(TARGET + '.pde')) 183 | sketchExt = '.ino' if path.exists(TARGET + '.ino') else '.pde' 184 | 185 | cFlags = ['-ffunction-sections', '-fdata-sections', '-fno-exceptions', 186 | '-funsigned-char', '-funsigned-bitfields', '-fpack-struct', 187 | '-fshort-enums', '-Os', '-Wall', '-mmcu=%s' % MCU] 188 | envArduino = Environment(CC = AVR_BIN_PREFIX + 'gcc', 189 | CXX = AVR_BIN_PREFIX + 'g++', 190 | AS = AVR_BIN_PREFIX + 'gcc', 191 | CPPPATH = ['build/core'], 192 | CPPDEFINES = {'F_CPU': F_CPU, 'ARDUINO': ARDUINO_VER}, 193 | CFLAGS = cFlags + ['-std=gnu99'], 194 | CCFLAGS = cFlags, 195 | ASFLAGS = ['-assembler-with-cpp','-mmcu=%s' % MCU], 196 | TOOLS = ['gcc','g++', 'as']) 197 | 198 | hwVariant = path.join(ARDUINO_HOME, 'hardware/arduino/variants', 199 | getBoardConf("build.variant", "")) 200 | if hwVariant: 201 | envArduino.Append(CPPPATH = hwVariant) 202 | 203 | def run(cmd): 204 | """Run a command and decipher the return code. Exit by default.""" 205 | print ' '.join(cmd) 206 | try: 207 | check_call(cmd) 208 | except CalledProcessError as cpe: 209 | print "Error: return code: " + str(cpe.returncode) 210 | sys.exit(cpe.returncode) 211 | 212 | # WindowXP not supported path.samefile 213 | def sameFile(p1, p2): 214 | if platform == 'win32': 215 | ap1 = path.abspath(p1) 216 | ap2 = path.abspath(p2) 217 | return ap1 == ap2 218 | return path.samefile(p1, p2) 219 | 220 | def fnProcessing(target, source, env): 221 | wp = open(str(target[0]), 'wb') 222 | wp.write(open(ARDUINO_SKEL).read()) 223 | 224 | types='''void 225 | int char word long 226 | float double byte long 227 | boolean 228 | uint8_t uint16_t uint32_t 229 | int8_t int16_t int32_t''' 230 | types=' | '.join(types.split()) 231 | re_signature = re.compile(r"""^\s* ( 232 | (?: (%s) \s+ )? 233 | \w+ \s* 234 | \( \s* ((%s) \s+ \*? \w+ (?:\s*,\s*)? )* \) 235 | ) \s* {? \s* $""" % (types, types), re.MULTILINE | re.VERBOSE) 236 | 237 | prototypes = {} 238 | 239 | for file in glob(path.realpath(os.curdir) + "/*" + sketchExt): 240 | for line in open(file): 241 | result = re_signature.search(line) 242 | if result: 243 | prototypes[result.group(1)] = result.group(2) 244 | 245 | for name in prototypes.iterkeys(): 246 | print "%s;" % name 247 | wp.write("%s;\n" % name) 248 | 249 | for file in glob(path.realpath(os.curdir) + "/*" + sketchExt): 250 | print file, TARGET 251 | if not sameFile(file, TARGET + sketchExt): 252 | wp.write('#line 1 "%s"\r\n' % file) 253 | wp.write(open(file).read()) 254 | 255 | # Add this preprocessor directive to localize the errors. 256 | sourcePath = str(source[0]).replace('\\', '\\\\') 257 | wp.write('#line 1 "%s"\r\n' % sourcePath) 258 | wp.write(open(str(source[0])).read()) 259 | 260 | def fnCompressCore(target, source, env): 261 | core_prefix = 'build/core/'.replace('/', os.path.sep) 262 | core_files = (x for x in imap(str, source) 263 | if x.startswith(core_prefix)) 264 | for file in core_files: 265 | run([AVR_BIN_PREFIX + 'ar', 'rcs', str(target[0]), file]) 266 | 267 | bldProcessing = Builder(action = fnProcessing) #, suffix = '.cpp', src_suffix = sketchExt) 268 | bldCompressCore = Builder(action = fnCompressCore) 269 | bldELF = Builder(action = AVR_BIN_PREFIX + 'gcc -mmcu=%s ' % MCU + 270 | '-Os -Wl,--gc-sections -lm -o $TARGET $SOURCES -lc') 271 | bldHEX = Builder(action = AVR_BIN_PREFIX + 'objcopy -O ihex -R .eeprom $SOURCES $TARGET') 272 | 273 | envArduino.Append(BUILDERS = {'Processing' : bldProcessing}) 274 | envArduino.Append(BUILDERS = {'CompressCore': bldCompressCore}) 275 | envArduino.Append(BUILDERS = {'Elf' : bldELF}) 276 | envArduino.Append(BUILDERS = {'Hex' : bldHEX}) 277 | 278 | ptnSource = re.compile(r'\.(?:c(?:pp)?|S)$') 279 | def gatherSources(srcpath): 280 | return [path.join(srcpath, f) for f 281 | in os.listdir(srcpath) if ptnSource.search(f)] 282 | 283 | # add arduino core sources 284 | VariantDir('build/core', ARDUINO_CORE) 285 | core_sources = gatherSources(ARDUINO_CORE) 286 | core_sources = [x.replace(ARDUINO_CORE, 'build/core/') for x 287 | in core_sources if path.basename(x) != 'main.cpp'] 288 | 289 | # add libraries 290 | libCandidates = [] 291 | ptnLib = re.compile(r'^[ ]*#[ ]*include [<"](.*)\.h[>"]') 292 | for line in open(TARGET + sketchExt): 293 | result = ptnLib.search(line) 294 | if not result: 295 | continue 296 | # Look for the library directory that contains the header. 297 | filename = result.group(1) + '.h' 298 | for libdir in ARDUINO_LIBS: 299 | for root, dirs, files in os.walk(libdir, followlinks=True): 300 | if filename in files: 301 | libCandidates.append(path.basename(root)) 302 | 303 | # Hack. In version 20 of the Arduino IDE, the Ethernet library depends 304 | # implicitly on the SPI library. 305 | if ARDUINO_VER >= 20 and 'Ethernet' in libCandidates: 306 | libCandidates.append('SPI') 307 | 308 | all_libs_sources = [] 309 | for index, orig_lib_dir in enumerate(ARDUINO_LIBS): 310 | lib_dir = 'build/lib_%02d' % index 311 | VariantDir(lib_dir, orig_lib_dir) 312 | for libPath in ifilter(path.isdir, glob(path.join(orig_lib_dir, '*'))): 313 | libName = path.basename(libPath) 314 | if not libName in libCandidates: 315 | continue 316 | envArduino.Append(CPPPATH = libPath.replace(orig_lib_dir, lib_dir)) 317 | lib_sources = gatherSources(libPath) 318 | utilDir = path.join(libPath, 'utility') 319 | if path.exists(utilDir) and path.isdir(utilDir): 320 | lib_sources += gatherSources(utilDir) 321 | envArduino.Append(CPPPATH = utilDir.replace(orig_lib_dir, lib_dir)) 322 | lib_sources = (x.replace(orig_lib_dir, lib_dir) for x in lib_sources) 323 | all_libs_sources.extend(lib_sources) 324 | 325 | # Add raw sources which live in sketch dir. 326 | build_top = path.realpath('.') 327 | VariantDir('build/local/', build_top) 328 | local_sources = gatherSources(build_top) 329 | local_sources = [x.replace(build_top, 'build/local/') for x in local_sources] 330 | if local_sources: 331 | envArduino.Append(CPPPATH = 'build/local') 332 | 333 | # Convert sketch(.pde) to cpp 334 | envArduino.Processing('build/' + TARGET + '.cpp', 'build/' + TARGET + sketchExt) 335 | VariantDir('build', '.') 336 | 337 | sources = ['build/' + TARGET + '.cpp'] 338 | #sources += core_sources 339 | sources += local_sources 340 | sources += all_libs_sources 341 | 342 | # Finally Build!! 343 | core_objs = envArduino.Object(core_sources) 344 | objs = envArduino.Object(sources) #, LIBS=libs, LIBPATH='.') 345 | objs = objs + envArduino.CompressCore('build/core.a', core_objs) 346 | envArduino.Elf(TARGET + '.elf', objs) 347 | envArduino.Hex(TARGET + '.hex', TARGET + '.elf') 348 | 349 | # Print Size 350 | # TODO: check binary size 351 | MAX_SIZE = getBoardConf('upload.maximum_size') 352 | print "maximum size for hex file: %s bytes" % MAX_SIZE 353 | envArduino.Command(None, TARGET + '.hex', AVR_BIN_PREFIX + 'size --target=ihex $SOURCE') 354 | 355 | # Reset 356 | def pulseDTR(target, source, env): 357 | import serial 358 | import time 359 | ser = serial.Serial(ARDUINO_PORT) 360 | ser.setDTR(1) 361 | time.sleep(0.5) 362 | ser.setDTR(0) 363 | ser.close() 364 | 365 | if RST_TRIGGER: 366 | reset_cmd = '%s %s' % (RST_TRIGGER, ARDUINO_PORT) 367 | else: 368 | reset_cmd = pulseDTR 369 | 370 | # Upload 371 | UPLOAD_PROTOCOL = getBoardConf('upload.protocol') 372 | UPLOAD_SPEED = getBoardConf('upload.speed') 373 | 374 | if UPLOAD_PROTOCOL == 'stk500': 375 | UPLOAD_PROTOCOL = 'stk500v1' 376 | 377 | 378 | avrdudeOpts = ['-V', '-F', '-c %s' % UPLOAD_PROTOCOL, '-b %s' % UPLOAD_SPEED, 379 | '-p %s' % MCU, '-P %s' % ARDUINO_PORT, '-U flash:w:$SOURCES'] 380 | if AVRDUDE_CONF: 381 | avrdudeOpts.append('-C %s' % AVRDUDE_CONF) 382 | 383 | fuse_cmd = '%s %s' % (path.join(path.dirname(AVR_BIN_PREFIX), 'avrdude'), 384 | ' '.join(avrdudeOpts)) 385 | 386 | upload = envArduino.Alias('upload', TARGET + '.hex', [reset_cmd, fuse_cmd]) 387 | AlwaysBuild(upload) 388 | 389 | # Clean build directory 390 | envArduino.Clean('all', 'build/') 391 | 392 | # vim: et sw=4 fenc=utf-8: 393 | -------------------------------------------------------------------------------- /arduino_testsuite/examples/verySlowTest/SConstruct: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | # scons script for the Arduino sketch 4 | # http://github.com/suapapa/arscons 5 | # 6 | # Copyright (C) 2010-2012 by Homin Lee 7 | # 8 | # This program is free software; you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation; either version 3 of the License, or 11 | # (at your option) any later version. 12 | 13 | # You'll need the serial module: http://pypi.python.org/pypi/pyserial 14 | 15 | # Basic Usage: 16 | # 1. make a folder which have same name of the sketch (ex. Blink/ for Blink.pde) 17 | # 2. put the sketch and SConstruct(this file) under the folder. 18 | # 3. to make the HEX. do following in the folder. 19 | # $ scons 20 | # 4. to upload the binary, do following in the folder. 21 | # $ scons upload 22 | 23 | # Thanks to: 24 | # * Ovidiu Predescu and Lee Pike 25 | # for Mac port and bugfix. 26 | # 27 | # This script tries to determine the port to which you have an Arduino 28 | # attached. If multiple USB serial devices are attached to your 29 | # computer, you'll need to explicitly specify the port to use, like 30 | # this: 31 | # 32 | # $ scons ARDUINO_PORT=/dev/ttyUSB0 33 | # 34 | # To add your own directory containing user libraries, pass EXTRA_LIB 35 | # to scons, like this: 36 | # 37 | # $ scons EXTRA_LIB= 38 | # 39 | 40 | from glob import glob 41 | from itertools import ifilter, imap 42 | from subprocess import check_call, CalledProcessError 43 | import sys 44 | import re 45 | import os 46 | from os import path 47 | from pprint import pprint 48 | 49 | env = Environment() 50 | platform = env['PLATFORM'] 51 | 52 | VARTAB = {} 53 | 54 | def resolve_var(varname, default_value): 55 | global VARTAB 56 | # precedence: scons argument -> environment variable -> default value 57 | ret = ARGUMENTS.get(varname, None) 58 | VARTAB[varname] = ('arg', ret) 59 | if ret == None: 60 | ret = os.environ.get(varname, None) 61 | VARTAB[varname] = ('env', ret) 62 | if ret == None: 63 | ret = default_value 64 | VARTAB[varname] = ('dfl', ret) 65 | return ret 66 | 67 | def getUsbTty(rx): 68 | usb_ttys = glob(rx) 69 | return usb_ttys[0] if len(usb_ttys) == 1 else None 70 | 71 | AVR_BIN_PREFIX = None 72 | AVRDUDE_CONF = None 73 | 74 | if platform == 'darwin': 75 | # For MacOS X, pick up the AVR tools from within Arduino.app 76 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', 77 | '/Applications/Arduino.app/Contents/Resources/Java') 78 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', getUsbTty('/dev/tty.usbserial*')) 79 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', '') 80 | AVR_HOME = resolve_var('AVR_HOME', 81 | path.join(ARDUINO_HOME, 'hardware/tools/avr/bin')) 82 | elif platform == 'win32': 83 | # For Windows, use environment variables. 84 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', None) 85 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', '') 86 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', '') 87 | if ARDUINO_HOME: 88 | AVR_HOME = resolve_var('AVR_HOME', 89 | path.join(ARDUINO_HOME, 'hardware/tools/avr/bin')) 90 | else: 91 | # For Ubuntu Linux (9.10 or higher) 92 | ARDUINO_HOME = resolve_var('ARDUINO_HOME', '/usr/share/arduino/') 93 | ARDUINO_PORT = resolve_var('ARDUINO_PORT', getUsbTty('/dev/ttyUSB*')) 94 | SKETCHBOOK_HOME = resolve_var('SKETCHBOOK_HOME', 95 | path.expanduser('~/share/arduino/sketchbook/')) 96 | AVR_HOME = resolve_var('AVR_HOME', '') 97 | 98 | 99 | ARDUINO_BOARD = resolve_var('ARDUINO_BOARD', 'atmega328') 100 | ARDUINO_VER = resolve_var('ARDUINO_VER', 0) # Default to 0 if nothing is specified 101 | RST_TRIGGER = resolve_var('RST_TRIGGER', None) # use built-in pulseDTR() by default 102 | EXTRA_LIB = resolve_var('EXTRA_LIB', None) # handy for adding another arduino-lib dir 103 | 104 | pprint(VARTAB, indent = 4) 105 | 106 | if not ARDUINO_HOME: 107 | print 'ARDUINO_HOME must be defined.' 108 | raise KeyError('ARDUINO_HOME') 109 | 110 | ARDUINO_CONF = path.join(ARDUINO_HOME, 'hardware/arduino/boards.txt') 111 | # check given board name, ARDUINO_BOARD is valid one 112 | arduino_boards = path.join(ARDUINO_HOME,'hardware/*/boards.txt') 113 | custom_boards = path.join(SKETCHBOOK_HOME,'hardware/*/boards.txt') 114 | board_files = glob(arduino_boards) + glob(custom_boards) 115 | ptnBoard = re.compile(r'^([^#]*)\.name=(.*)') 116 | boards = {} 117 | for bf in board_files: 118 | for line in open(bf): 119 | result = ptnBoard.match(line) 120 | if result: 121 | boards[result.group(1)] = (result.group(2), bf) 122 | 123 | if ARDUINO_BOARD not in boards: 124 | print "ERROR! the given board name, %s is not in the supported board list:" % ARDUINO_BOARD 125 | print "all available board names are:" 126 | for name, description in boards.iteritems(): 127 | print "\t%s for %s" % (name.ljust(14), description[0]) 128 | #print "however, you may edit %s to add a new board." % ARDUINO_CONF 129 | sys.exit(-1) 130 | 131 | ARDUINO_CONF = boards[ARDUINO_BOARD][1] 132 | 133 | def getBoardConf(conf, default = None): 134 | for line in open(ARDUINO_CONF): 135 | line = line.strip() 136 | if '=' in line: 137 | key, value = line.split('=') 138 | if key == '.'.join([ARDUINO_BOARD, conf]): 139 | return value 140 | ret = default 141 | if ret == None: 142 | print "ERROR! can't find %s in %s" % (conf, ARDUINO_CONF) 143 | assert(False) 144 | return ret 145 | 146 | ARDUINO_CORE = path.join(ARDUINO_HOME, path.dirname(ARDUINO_CONF), 147 | 'cores/', getBoardConf('build.core', 'arduino')) 148 | ARDUINO_SKEL = path.join(ARDUINO_CORE, 'main.cpp') 149 | 150 | if ARDUINO_VER == 0: 151 | arduinoHeader = path.join(ARDUINO_CORE, 'Arduino.h') 152 | print "No Arduino version specified. Discovered version", 153 | if path.exists(arduinoHeader): 154 | print "100 or above" 155 | ARDUINO_VER = 100 156 | else: 157 | print "0023 or below" 158 | ARDUINO_VER = 23 159 | else: 160 | print "Arduino version " + ARDUINO_VER + " specified" 161 | 162 | # Some OSs need bundle with IDE tool-chain 163 | if platform == 'darwin' or platform == 'win32': 164 | AVRDUDE_CONF = path.join(ARDUINO_HOME, 'hardware/tools/avr/etc/avrdude.conf') 165 | 166 | AVR_BIN_PREFIX = path.join(AVR_HOME, 'avr-') 167 | 168 | ARDUINO_LIBS = [path.join(ARDUINO_HOME, 'libraries')] 169 | if EXTRA_LIB: 170 | ARDUINO_LIBS.append(EXTRA_LIB) 171 | if SKETCHBOOK_HOME: 172 | ARDUINO_LIBS.append(path.join(SKETCHBOOK_HOME, 'libraries')) 173 | 174 | 175 | # Override MCU and F_CPU 176 | MCU = ARGUMENTS.get('MCU', getBoardConf('build.mcu')) 177 | F_CPU = ARGUMENTS.get('F_CPU', getBoardConf('build.f_cpu')) 178 | 179 | # There should be a file with the same name as the folder and 180 | # with the extension .pde or .ino 181 | TARGET = path.basename(path.realpath(os.curdir)) 182 | assert(path.exists(TARGET + '.ino') or path.exists(TARGET + '.pde')) 183 | sketchExt = '.ino' if path.exists(TARGET + '.ino') else '.pde' 184 | 185 | cFlags = ['-ffunction-sections', '-fdata-sections', '-fno-exceptions', 186 | '-funsigned-char', '-funsigned-bitfields', '-fpack-struct', 187 | '-fshort-enums', '-Os', '-Wall', '-mmcu=%s' % MCU] 188 | envArduino = Environment(CC = AVR_BIN_PREFIX + 'gcc', 189 | CXX = AVR_BIN_PREFIX + 'g++', 190 | AS = AVR_BIN_PREFIX + 'gcc', 191 | CPPPATH = ['build/core'], 192 | CPPDEFINES = {'F_CPU': F_CPU, 'ARDUINO': ARDUINO_VER}, 193 | CFLAGS = cFlags + ['-std=gnu99'], 194 | CCFLAGS = cFlags, 195 | ASFLAGS = ['-assembler-with-cpp','-mmcu=%s' % MCU], 196 | TOOLS = ['gcc','g++', 'as']) 197 | 198 | hwVariant = path.join(ARDUINO_HOME, 'hardware/arduino/variants', 199 | getBoardConf("build.variant", "")) 200 | if hwVariant: 201 | envArduino.Append(CPPPATH = hwVariant) 202 | 203 | def run(cmd): 204 | """Run a command and decipher the return code. Exit by default.""" 205 | print ' '.join(cmd) 206 | try: 207 | check_call(cmd) 208 | except CalledProcessError as cpe: 209 | print "Error: return code: " + str(cpe.returncode) 210 | sys.exit(cpe.returncode) 211 | 212 | # WindowXP not supported path.samefile 213 | def sameFile(p1, p2): 214 | if platform == 'win32': 215 | ap1 = path.abspath(p1) 216 | ap2 = path.abspath(p2) 217 | return ap1 == ap2 218 | return path.samefile(p1, p2) 219 | 220 | def fnProcessing(target, source, env): 221 | wp = open(str(target[0]), 'wb') 222 | wp.write(open(ARDUINO_SKEL).read()) 223 | 224 | types='''void 225 | int char word long 226 | float double byte long 227 | boolean 228 | uint8_t uint16_t uint32_t 229 | int8_t int16_t int32_t''' 230 | types=' | '.join(types.split()) 231 | re_signature = re.compile(r"""^\s* ( 232 | (?: (%s) \s+ )? 233 | \w+ \s* 234 | \( \s* ((%s) \s+ \*? \w+ (?:\s*,\s*)? )* \) 235 | ) \s* {? \s* $""" % (types, types), re.MULTILINE | re.VERBOSE) 236 | 237 | prototypes = {} 238 | 239 | for file in glob(path.realpath(os.curdir) + "/*" + sketchExt): 240 | for line in open(file): 241 | result = re_signature.search(line) 242 | if result: 243 | prototypes[result.group(1)] = result.group(2) 244 | 245 | for name in prototypes.iterkeys(): 246 | print "%s;" % name 247 | wp.write("%s;\n" % name) 248 | 249 | for file in glob(path.realpath(os.curdir) + "/*" + sketchExt): 250 | print file, TARGET 251 | if not sameFile(file, TARGET + sketchExt): 252 | wp.write('#line 1 "%s"\r\n' % file) 253 | wp.write(open(file).read()) 254 | 255 | # Add this preprocessor directive to localize the errors. 256 | sourcePath = str(source[0]).replace('\\', '\\\\') 257 | wp.write('#line 1 "%s"\r\n' % sourcePath) 258 | wp.write(open(str(source[0])).read()) 259 | 260 | def fnCompressCore(target, source, env): 261 | core_prefix = 'build/core/'.replace('/', os.path.sep) 262 | core_files = (x for x in imap(str, source) 263 | if x.startswith(core_prefix)) 264 | for file in core_files: 265 | run([AVR_BIN_PREFIX + 'ar', 'rcs', str(target[0]), file]) 266 | 267 | bldProcessing = Builder(action = fnProcessing) #, suffix = '.cpp', src_suffix = sketchExt) 268 | bldCompressCore = Builder(action = fnCompressCore) 269 | bldELF = Builder(action = AVR_BIN_PREFIX + 'gcc -mmcu=%s ' % MCU + 270 | '-Os -Wl,--gc-sections -lm -o $TARGET $SOURCES -lc') 271 | bldHEX = Builder(action = AVR_BIN_PREFIX + 'objcopy -O ihex -R .eeprom $SOURCES $TARGET') 272 | 273 | envArduino.Append(BUILDERS = {'Processing' : bldProcessing}) 274 | envArduino.Append(BUILDERS = {'CompressCore': bldCompressCore}) 275 | envArduino.Append(BUILDERS = {'Elf' : bldELF}) 276 | envArduino.Append(BUILDERS = {'Hex' : bldHEX}) 277 | 278 | ptnSource = re.compile(r'\.(?:c(?:pp)?|S)$') 279 | def gatherSources(srcpath): 280 | return [path.join(srcpath, f) for f 281 | in os.listdir(srcpath) if ptnSource.search(f)] 282 | 283 | # add arduino core sources 284 | VariantDir('build/core', ARDUINO_CORE) 285 | core_sources = gatherSources(ARDUINO_CORE) 286 | core_sources = [x.replace(ARDUINO_CORE, 'build/core/') for x 287 | in core_sources if path.basename(x) != 'main.cpp'] 288 | 289 | # add libraries 290 | libCandidates = [] 291 | ptnLib = re.compile(r'^[ ]*#[ ]*include [<"](.*)\.h[>"]') 292 | for line in open(TARGET + sketchExt): 293 | result = ptnLib.search(line) 294 | if not result: 295 | continue 296 | # Look for the library directory that contains the header. 297 | filename = result.group(1) + '.h' 298 | for libdir in ARDUINO_LIBS: 299 | for root, dirs, files in os.walk(libdir, followlinks=True): 300 | if filename in files: 301 | libCandidates.append(path.basename(root)) 302 | 303 | # Hack. In version 20 of the Arduino IDE, the Ethernet library depends 304 | # implicitly on the SPI library. 305 | if ARDUINO_VER >= 20 and 'Ethernet' in libCandidates: 306 | libCandidates.append('SPI') 307 | 308 | all_libs_sources = [] 309 | for index, orig_lib_dir in enumerate(ARDUINO_LIBS): 310 | lib_dir = 'build/lib_%02d' % index 311 | VariantDir(lib_dir, orig_lib_dir) 312 | for libPath in ifilter(path.isdir, glob(path.join(orig_lib_dir, '*'))): 313 | libName = path.basename(libPath) 314 | if not libName in libCandidates: 315 | continue 316 | envArduino.Append(CPPPATH = libPath.replace(orig_lib_dir, lib_dir)) 317 | lib_sources = gatherSources(libPath) 318 | utilDir = path.join(libPath, 'utility') 319 | if path.exists(utilDir) and path.isdir(utilDir): 320 | lib_sources += gatherSources(utilDir) 321 | envArduino.Append(CPPPATH = utilDir.replace(orig_lib_dir, lib_dir)) 322 | lib_sources = (x.replace(orig_lib_dir, lib_dir) for x in lib_sources) 323 | all_libs_sources.extend(lib_sources) 324 | 325 | # Add raw sources which live in sketch dir. 326 | build_top = path.realpath('.') 327 | VariantDir('build/local/', build_top) 328 | local_sources = gatherSources(build_top) 329 | local_sources = [x.replace(build_top, 'build/local/') for x in local_sources] 330 | if local_sources: 331 | envArduino.Append(CPPPATH = 'build/local') 332 | 333 | # Convert sketch(.pde) to cpp 334 | envArduino.Processing('build/' + TARGET + '.cpp', 'build/' + TARGET + sketchExt) 335 | VariantDir('build', '.') 336 | 337 | sources = ['build/' + TARGET + '.cpp'] 338 | #sources += core_sources 339 | sources += local_sources 340 | sources += all_libs_sources 341 | 342 | # Finally Build!! 343 | core_objs = envArduino.Object(core_sources) 344 | objs = envArduino.Object(sources) #, LIBS=libs, LIBPATH='.') 345 | objs = objs + envArduino.CompressCore('build/core.a', core_objs) 346 | envArduino.Elf(TARGET + '.elf', objs) 347 | envArduino.Hex(TARGET + '.hex', TARGET + '.elf') 348 | 349 | # Print Size 350 | # TODO: check binary size 351 | MAX_SIZE = getBoardConf('upload.maximum_size') 352 | print "maximum size for hex file: %s bytes" % MAX_SIZE 353 | envArduino.Command(None, TARGET + '.hex', AVR_BIN_PREFIX + 'size --target=ihex $SOURCE') 354 | 355 | # Reset 356 | def pulseDTR(target, source, env): 357 | import serial 358 | import time 359 | ser = serial.Serial(ARDUINO_PORT) 360 | ser.setDTR(1) 361 | time.sleep(0.5) 362 | ser.setDTR(0) 363 | ser.close() 364 | 365 | if RST_TRIGGER: 366 | reset_cmd = '%s %s' % (RST_TRIGGER, ARDUINO_PORT) 367 | else: 368 | reset_cmd = pulseDTR 369 | 370 | # Upload 371 | UPLOAD_PROTOCOL = getBoardConf('upload.protocol') 372 | UPLOAD_SPEED = getBoardConf('upload.speed') 373 | 374 | if UPLOAD_PROTOCOL == 'stk500': 375 | UPLOAD_PROTOCOL = 'stk500v1' 376 | 377 | 378 | avrdudeOpts = ['-V', '-F', '-c %s' % UPLOAD_PROTOCOL, '-b %s' % UPLOAD_SPEED, 379 | '-p %s' % MCU, '-P %s' % ARDUINO_PORT, '-U flash:w:$SOURCES'] 380 | if AVRDUDE_CONF: 381 | avrdudeOpts.append('-C %s' % AVRDUDE_CONF) 382 | 383 | fuse_cmd = '%s %s' % (path.join(path.dirname(AVR_BIN_PREFIX), 'avrdude'), 384 | ' '.join(avrdudeOpts)) 385 | 386 | upload = envArduino.Alias('upload', TARGET + '.hex', [reset_cmd, fuse_cmd]) 387 | AlwaysBuild(upload) 388 | 389 | # Clean build directory 390 | envArduino.Clean('all', 'build/') 391 | 392 | # vim: et sw=4 fenc=utf-8: 393 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------