arduino.py

# platform-apollo3blue: Apollo3Blue development platform for platformio.
# Copyright 2019-present NigelB
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from os.path import isdir, split, join
from SCons.Script import AlwaysBuild, Builder, Default, DefaultEnvironment, COMMAND_LINE_TARGETS
import sys
import platform as sys_pf


def launch_arduino_core_builder(env, platform, board):
    FRAMEWORK_DIR = platform.get_package_dir("framework-arduinoapollo3")
    project = env.GetProjectConfig()
    assert isdir(FRAMEWORK_DIR)

    framework_version = platform.get_package_version("framework-arduinoapollo3")
    if "+" in framework_version:
        framework_semantic_version, framework_commit = framework_version.split("+")
        major, minor, patch = framework_semantic_version.split(".")
    else:
        major, minor, patch = framework_version.split(".")

    major = int(major)
    minor = int(minor)
    patch = int(patch)

    script_name= "unknown"

    if major == 1:
        script_name = "core_v1"
        try:
            board.get("build.framework.arduino.v1")
        except:
            sys.stderr.write('Error: Board: "%s" not supported by Arduino_Apollo3-%s\n'%(board.get("name"), framework_version))
            env.Exit(1)
    elif major == 2:
        script_name = "core_v2"
        try:
            board.get("build.framework.arduino.v2")
        except:
            sys.stderr.write('Error: Board: "%s" not supported by Arduino_Apollo3-%s\n'%(board.get("name"), framework_version))
            env.Exit(1)
    else:
        sys.stderr.write('Error: Could not find builder for "%s" "%s" ' % (board.get("name"), framework_version))
        env.Exit(1)

    env.SConscript(join("arduino", "%s.py" % script_name))


def configure_uploader(env):
    upload_protocol = env.subst("$UPLOAD_PROTOCOL")

    system_type = sys_pf.system().lower() if sys_pf.system() != "Darwin" else "macosx"
    if upload_protocol in ["svl", "asb"]:
        upload_program = None
        if upload_protocol == "svl":
            upload_program = env.subst("$SVL_UPLOADER")
        elif upload_protocol == "asb":
            upload_program = env.subst("$ASB_UPLOADER")
        else:
            sys.stderr.write("Error: cannot determine the uploader program\n")
            env.Exit(1)

        if system_type == "windows":
            upload_program += ".exe"

        env.Replace(UPLOADER=upload_program)


def configure_upload_address(env, board):
    upload_protocol = env.subst("$UPLOAD_PROTOCOL")
    upload_address = ""
    if upload_protocol == "svl":
        upload_address = "0x10000"
    elif upload_protocol == "asb":
        upload_address = "0xC000"
    elif upload_protocol == "jlink":
        upload_address = "0x10000"
    user_upload_address = board.get("build.upload.address", "").strip()
    if len(user_upload_address) > 0:
        upload_address = user_upload_address
    env.Replace(UPLOAD_ADDRESS=upload_address)


env = DefaultEnvironment()
platform = env.PioPlatform()
board = env.BoardConfig()

launch_arduino_core_builder(env, platform, board)
configure_uploader(env)
configure_upload_address(env, board)