bootstrap.sh

#!/bin/bash
# 
# Download an patch the nRF5 SDK in order to compile the connectivity application.
#
# The SDK download link can be configured. The SDK is downloaded and extracted to 
# the configured folder. A custom patch file is then be applied.
#
# All the paths provided as arguments are relative to the location of this script.
# Usage: Usage: bootstrap -l link -d destination -p patch [-h]
# 
# Adapted from 'https://github.com/NordicPlayground/nrf5-sdk-for-eddystone'.
# Version 0.5

ABS_PATH="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"

# SDK download link (as zip file, full URL with extension)
function set_sdk_link () {
    SDK_LINK=$1

    SDK_FILE=${SDK_LINK##*/}  # SDK file name with extension
    SDK_NAME=${SDK_FILE%.zip} # SDK folder name without extension
}

function set_familypack_link () {
    FAMILYPACK_LINK=$1

    FAMILYPACK_FILE=${FAMILYPACK_LINK##*/}
    FAMILYPACK_NAME=${FAMILYPACK_FILE%.pack}
}

# Configuration of the destination folder (relative path from this script)
function set_dl_location () {
    DL_LOCATION="$ABS_PATH/$1"
}

# Configuration of the patch file name (relative path from this script)
function set_patch_file () {
    PATCH_FILE="$ABS_PATH/$1"
}

function usage () {
    echo "Usage: bootstrap -l link -d destination -p patch [-h]"
    echo
    echo " -l, --link   SDK download link"
    echo " -d, --dest   Destination folder of the downloaded SDK"
    echo " -p, --patch  Patch file to apply to the downloaded SDK"
    echo
    echo " -h, --help   Show this help message"
}

# Display an error message
function error () {
    printf "\e[1;31m[ERROR] $1\e[0;0m\r\n"
}

# Display a fatal error and exit
function fatal () {
    error "$@"
    exit
}

# Check if the required program are available
function check_requirements () {
    command -v unzip >/dev/null 2>&1 || { fatal "Unzip is not available"; }
    command -v curl >/dev/null 2>&1 || { fatal "Curl is not available"; }
    command -v git >/dev/null 2>&1 || { fatal "Git is not available"; }
    command -v patch >/dev/null 2>&1 || { fatal "Patch is not available"; }
}

# Check if the required parameters have been set
function check_config () {
    if [[ -z "${SDK_LINK}" ]]; then
        error "Download SDK link has not been set"
        usage
        exit
    fi

    if [[ -z "${DL_LOCATION}" ]]; then
        error "Download location folder has not been set"
        usage
        exit
    fi

    if [[ -z "${PATCH_FILE}" ]]; then
        error "Patch file has not been set"
        usage
        exit
    fi
}

# Check if the SDK folder already exist
function sdk_exists () {
    if [[ -d $DL_LOCATION && -d $DL_LOCATION/$SDK_NAME ]]; then
        # Erase the existing SDK folder if needed
        echo "> SDK folder '${SDK_NAME}' already available"
        read -p "> Do you want to erase the existing SDK folder [Y/n]? " -n 1 -r
        echo

        if [[ $REPLY =~ ^[Y]$ ]]; then
            echo "> Deleting existing SDK folder..."
            rm -rf $DL_LOCATION/$SDK_NAME
        else
            return 0 # Exists
        fi
    fi

    # No SDK folder available
    return 1
}

# Patch the downloaded SDK in order to compile the connectivity application
function sdk_patch () {
    # Detect which OS is running
    UNAME="$(uname)"
    # If OS is Linux or Darwin
    # Change the format of line ending to unix
    if [[ "${UNAME}" == "Linux" ]]; then
        echo "> Modifying SDK line ending format..."
        find $DL_LOCATION/$SDK_NAME/ -type f -exec sed -i $'s/\r//' {} \;
    fi
    if [[ "${UNAME}" == "Darwin" ]]; then
        echo "> Modifying SDK line ending format..."
        LC_CTYPE=C
        find $DL_LOCATION/$SDK_NAME/ -type f -exec sed -i '' $'s/\r//' {} \;
    fi

    echo "> Applying SDK patch '${PATCH_FILE}'..."

    # Apply the patch from the base nRF SDK folder (remove the first portion of the path)
    # FIXME: check if the patch has been already applied
    patch -d $DL_LOCATION/$SDK_NAME/ -p1 -s --ignore-whitespace -i $PATCH_FILE

    err_code=$?
    if [ "$err_code" != "0" ]; then
        # The patch has been probably already applied
        fatal "Patch does not apply"
    fi
}

# Download and patch the SDK. Check if it is already available
function sdk_download () {
    # First check if the SDK already exist
    if sdk_exists $1; then
        # SDK folder already available (assume patched)
        return 0
    fi

    if [[ -z "${SDK_NAME}" ]]; then
        fatal "Invalid SDK link"
    fi

    # Create the destination folder and download the SDK
    echo "> Downloading nRF SDK '${SDK_NAME}'..."

    mkdir -p $DL_LOCATION

    curl --progress-bar -o $DL_LOCATION/$SDK_FILE $SDK_LINK

    err_code=$?
    if [ "$err_code" != "0" ]; then
        fatal "Could not download SDK from '${SDK_LINK}'"
    fi

    echo "> Unzipping SDK..."
    # Disable globbing of files/directories we do not want to extract from the ZIP file
    set -f
    ZIP_EXCLUDE_LIST="**/*.msi **/external/cifra_AES128-EAX/** **/external/cJSON/** **/external/fatfs/** **/external/fnmatch/** **/external/freertos/** **/external/infineon/** **/external/licenses_external.txt** **/external/lwip/** **/external/mbedtls/** **/external/micro-ecc/** **/external/nano/** **/external/nano-pb/** **/external/nfc_adafruit_library/** **/external/nrf_cc310/** **/external/nrf_cc310_bl/** **/external/nrf_oberon/** **/external/nrf_tls/** **/external/protothreads/** **/external/thedotfactory_fonts/** **/components/802_15_4/** **/components/ant/** **/components/drivers_ext/** **/components/iot/** **/components/nfc/** **/components/proprietary_rf/** **/components/softdevice/s112/** **/components/softdevice/s140/** **/components/softdevice/s212/** **/examples/802_15_4/** **/examples/ant/** **/examples/ble_** **/examples/usb_** **/examples/iot/** **/examples/peripheral/** **/examples/proprietary_rf/** **/examples/dfu/** **/examples/crypto/** **/examples/nfc/** **/examples/dtm/** **/examples/multiprotocol/** **/examples/connectivity/experimental_ant/** **/examples/connectivity/ble_connectivity/**/ser_s*_spi*/** **/examples/connectivity/ble_connectivity/**/ser_s*_uart/** **/examples/connectivity/ble_connectivity/pca10040e/** **/documentation/**"
    unzip -n -q $DL_LOCATION/$SDK_FILE -d $DL_LOCATION -x $ZIP_EXCLUDE_LIST
    set +f

    err_code=$?
    if [ "$err_code" != "0" ]; then
        fatal "Could not unzip the SDK file"
    fi

    echo "> Clean up. Removing SDK zip file..."
    rm $DL_LOCATION/$SDK_FILE

    err_code=$?
    if [ "$err_code" != "0" ]; then
        fatal "Could not remove the SDK zip file"
    fi

    # FIXME: unused files from the modified SDK should be deleted
    # Keep only the components and the connectivity application ?
}

function familypack_download () {
    if [[ -z "${FAMILYPACK_NAME}" ]]; then
        fatal "Invalid Device Family Pack link"
    fi

    echo "> Downloading Device Family Pack '${FAMILYPACK_NAME}'..."

    curl --progress-bar -o $DL_LOCATION/$SDK_NAME/$FAMILYPACK_FILE $FAMILYPACK_LINK

    err_code=$?
    if [ "$err_code" != "0" ]; then
        fatal "Could not download Device Family Pack from '${FAMILYPACK_LINK}'"
    fi
}

function main() {

    while [ "$1" != "" ]; do
        case $1 in
            -l | --link )  shift
                           set_sdk_link $1
                           ;;
            -f | --familypack ) shift
                           set_familypack_link $1
                           ;;
            -d | --dest )  shift
                           set_dl_location $1
                           ;;
            -p | --patch ) shift
                           set_patch_file $1
                           ;;
            -h | --help )  usage
                           exit
                           ;;
            * )            usage
                           exit 1
        esac
        shift
    done

    check_requirements
    check_config
    sdk_download
    sdk_patch
    familypack_download

    echo "> SDK ready to use. Exit."
    exit
}

if [ "${1}" != "--source-only" ]; then
   main "$@"
fi