first commit

buildroot/bin/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

buildroot/bin/build_all_examples

@@ -0,0 +1,213 @@
+#!/usr/bin/env bash
+#
+# Usage:
+#
+#  build_all_examples [-b|--branch=<branch>] - Branch to fetch from Configurations repo (import-2.1.x)
+#                     [-B|--base]            - Base path of configurations, overriding -b
+#                     [-c|--continue]        - Continue the paused build
+#                     [-p|--purge]           - Purge the status file and start over
+#                     [-s|--skip]            - Continue the paused build, skipping one
+#                     [-r|--resume=<path>]   - Start at some config in the filesystem order
+#                     [-l|--limit=#]         - Limit the number of builds in this run
+#                     [-d|--debug]           - Print extra debug output (after)
+#                     [-n|--nobuild]         - Don't actually build anything
+#                     [-f|--nofail]          - Don't stop on a failed build
+#                     [-e|--export=N]        - Set CONFIG_EXPORT and export into each config folder
+#                     [-a|--archive]         - Copy the binary to the export location
+#                     [-o|--output]          - Redirect export / archiving to another location
+#                                              (By default export to origin config folders)
+#                     [-h|--help]            - Print usage and exit
+#
+
+HERE=`dirname $0`
+PATH="$HERE:$PATH"
+
+. mfutil
+
+GITREPO=https://github.com/MarlinFirmware/Configurations.git
+STAT_FILE=./.pio/.buildall
+
+usage() { echo "Usage:
+
+build_all_examples [-b|--branch=<branch>] - Branch to fetch from Configurations repo (import-2.1.x)
+                   [-B|--base]            - Base path of configurations, overriding -b
+                   [-c|--continue]        - Continue the paused build
+                   [-p|--purge]           - Purge the status file and start over
+                   [-s|--skip]            - Continue the paused build, skipping one
+                   [-r|--resume=<path>]   - Start at some config in the filesystem order
+                   [-e|--export=N]        - Set CONFIG_EXPORT and export to the export location
+                   [-a|--archive]         - Copy the binary to the export location
+                   [-o|--output]          - Redirect export / archiving to another location
+                                            (By default export to origin config folders)
+                   [-d|--debug]           - Print extra debug output (after)
+                   [-l|--limit=#]         - Limit the number of builds in this run
+                   [-n|--nobuild]         - Don't actually build anything
+                   [-f|--nofail]          - Don't stop on a failed build
+                   [-h|--help]            - Print usage and exit
+"
+}
+
+# Assume the most recent configs
+BRANCH=import-2.1.x
+unset FIRST_CONF
+EXIT_USAGE=
+LIMIT=1000
+
+while getopts 'aB:b:ce:fdhl:no:pr:sv-:' OFLAG; do
+  case "${OFLAG}" in
+    a) ARCHIVE=1                ; bugout "Archiving" ;;
+    B) CBASE=${OPTARG%/}        ; bugout "Base: $CBASE" ;;
+    b) BRANCH=$OPTARG           ; bugout "Branch: $BRANCH" ;;
+    f) NOFAIL=1                 ; bugout "Continue on Fail" ;;
+    r) ISRES=1 ; FIRST_CONF=$OPTARG ; bugout "Resume: $FIRST_CONF" ;;
+    c) CONTINUE=1               ; bugout "Continue" ;;
+    s) CONTSKIP=1               ; bugout "Continue, skipping" ;;
+    e) CEXPORT=$OPTARG          ; bugout "Export $CEXPORT" ;;
+    o) OUTBASE="${OPTARG%/}"    ; bugout "Archive to $OUTBASE" ;;
+    h) EXIT_USAGE=1 ; break ;;
+    l) LIMIT=$OPTARG            ; bugout "Limit to $LIMIT build(s)" ;;
+  d|v) DEBUG=1                  ; bugout "Debug ON" ;;
+    n) DRYRUN=1                 ; bugout "Dry Run" ;;
+    p) PURGE=1                  ; bugout "Purge stat file" ;;
+    -) ONAM="${OPTARG%%=*}" ; OVAL="${OPTARG#*=}"
+       case "$ONAM" in
+      archive) ARCHIVE=1        ; bugout "Archiving" ;;
+         base) CBASE=${OVAL%/}  ; bugout "Base: $CBASE" ;;
+       branch) BRANCH=$OVAL     ; bugout "Branch: $BRANCH" ;;
+       nofail) NOFAIL=1         ; bugout "Continue on Fail" ;;
+       resume) ISRES=1 ; FIRST_CONF=$OVAL ; bugout "Resume: $FIRST_CONF" ;;
+     continue) CONTINUE=1       ; bugout "Continue" ;;
+         skip) CONTSKIP=1       ; bugout "Continue, skipping" ;;
+       export) CEXPORT=$OVAL    ; bugout "Export $EXPORT" ;;
+       output) OUTBASE="${OVAL%/}" ; bugout "Archive to $OUTBASE" ;;
+        limit) LIMIT=$OVAL      ; bugout "Limit to $LIMIT build(s)" ;;
+         help) [[ -z "$OVAL" ]] || perror "option can't take value $OVAL" $ONAM ; EXIT_USAGE=1 ;;
+        debug) DEBUG=1          ; bugout "Debug ON" ;;
+      nobuild) DRYRUN=1         ; bugout "Dry Run" ;;
+        purge) PURGE=1          ; bugout "Purge stat file" ;;
+            *) EXIT_USAGE=2 ; echo "$SELF: unrecognized option \`--$ONAM'" ; break ;;
+       esac
+       ;;
+    *) EXIT_USAGE=2 ; break ;;
+  esac
+done
+shift $((OPTIND - 1))
+
+# Check for mixed continue, skip, resume arguments. Only one should be used.
+((CONTINUE + CONTSKIP + ISRES + PURGE > 1)) && { echo "Don't mix -c, -p, -s, and -r options" ; echo ; EXIT_USAGE=2 ; }
+
+# Exit with helpful usage information
+((EXIT_USAGE)) && { usage ; let EXIT_USAGE-- ; exit $EXIT_USAGE ; }
+
+echo
+echo "This script downloads all example configs and attempts to build them."
+echo "On failure the last-built configs are left in your working copy."
+echo "Restore your configs with 'git checkout -f' or 'git reset --hard HEAD'."
+echo
+
+[[ -n $PURGE ]] && rm -f "$STAT_FILE"
+[[ -z $FIRST_CONF && -f "$STAT_FILE" ]] && IFS='*' read BRANCH FIRST_CONF <"$STAT_FILE"
+
+# If -c is given start from the last attempted build
+if ((CONTINUE)); then
+  if [[ -z $BRANCH || -z $FIRST_CONF ]]; then
+    echo "Nothing to continue"
+    exit
+  fi
+elif ((CONTSKIP)); then
+  if [[ -n $BRANCH && -n $FIRST_CONF ]]; then
+    SKIP_CONF=1
+  else
+    echo "Nothing to skip"
+    exit
+  fi
+fi
+
+# Check if the current repository has unmerged changes
+if ((SKIP_CONF)); then
+  echo "Skipping $FIRST_CONF"
+elif [[ -n $FIRST_CONF ]]; then
+  echo "Resuming from $FIRST_CONF"
+else
+  git diff --quiet || { echo "The working copy is modified. Commit or stash changes before proceeding."; exit ; }
+fi
+
+# Check for the given base path
+if [[ -n $CBASE ]]; then
+  CBASE="${CBASE/#\~/$HOME}"
+  [[ -d "$CBASE" ]] || { echo "Given base -B $CBASE not found." ; exit ; }
+else
+  # Make a Configurations temporary folder if needed
+  CBASE=./.pio/build-$BRANCH
+  [[ -d "$CBASE" ]] || mkdir -p "$CBASE"
+  # Download the specified Configurations branch if needed
+  if [[ ! -e "$CBASE/README.md" ]]; then
+    echo "Fetching Configurations from GitHub to $CBASE"
+    git clone --depth=1 --single-branch --branch "$BRANCH" $GITREPO "$CBASE" || { echo "Failed to clone the configuration repository"; exit ; }
+  fi
+fi
+
+# Build
+echo -e "=====================\nProceed with builds...\n====================="
+shopt -s nullglob
+
+export PAUSE=1
+
+# Get a list of all folders that contain a file matching "Configuration*.h"
+find -ds "$CBASE"/config/examples -type d -name 'Configuration.h' -o -name 'Configuration_adv.h' -print0 | while IFS= read -r -d $'\0' CONF; do
+
+  # Remove the file name and slash from the end of the path
+  CONF=${CONF%/*}
+
+  # Get a config's directory name
+  DIR=${CONF#$CBASE/config/examples/}
+
+  # If looking for a config, skip others
+  [[ $FIRST_CONF ]] && [[ $FIRST_CONF != $DIR && "$FIRST_CONF/" != $DIR ]] && { ((DEBUG)) && echo "[SKIP] $DIR" ; continue ; }
+  # Once found, stop looking
+  unset FIRST_CONF
+
+  # If skipping, don't build the found one
+  [[ $SKIP_CONF ]] && { unset SKIP_CONF ; continue ; }
+
+  # Either Configuration.h or Configuration_adv.h must exist
+  [[ -f "$CONF"/Configuration.h || -f "$CONF"/Configuration_adv.h ]] || { echo "[NONE] $DIR" ; continue ; }
+
+  # Command arguments for 'build_example'
+  CARGS=("-b" "$CBASE" "-c" "$DIR")
+
+  # Exporting? Add -e argument
+  ((CEXPORT)) && CARGS+=("-e" "$CEXPORT")
+
+  # Continue on fail? Add -f argument
+  ((NOFAIL)) && CARGS+=("-f")
+
+  # Archive the build? Add -a argument
+  ((ARCHIVE)) && CARGS+=("-a")
+
+  # Redirecting the export/archive output? Add -o argument
+  [[ -n $OUTBASE ]] && CARGS+=("-o" "$OUTBASE")
+
+  # Build or print build command for --nobuild
+  if ((DRYRUN)); then
+    echo -e "\033[0;32m[DRYRUN] build_example ${CARGS[@]}\033[0m"
+  else
+    # Remember where we are in case of failure
+    echo "${BRANCH}*${DIR}" >"$STAT_FILE"
+    ((DEBUG)) && echo "build_example ${CARGS[@]}"
+    # Invoke build_example
+    build_example "${CARGS[@]}" || { echo "Failed to build $DIR" ; exit ; }
+  fi
+
+  echo
+  ((--LIMIT)) || { echo "Specified limit reached" ; break ; }
+  echo
+
+  export PAUSE=0
+
+done
+
+echo "Exiting"
+
+# Delete the build state if not paused early
+((PAUSE)) || rm -f "$STAT_FILE"

buildroot/bin/build_example

@@ -0,0 +1,229 @@
+#!/usr/bin/env bash
+#
+# Usage:
+#
+#  build_example  -b|--base=<path>    - Configurations root folder (e.g., ./.pio/build-BRANCH)
+#                 -c|--config=<rel>   - Sub-path of the configs to build (within config/examples)
+#                [-e|--export=N]      - Use CONFIG_EXPORT N to export the config to the export location
+#                [-a|--archive]       - Archive the build (to the export location)
+#                [-o|--output]        - Redirect export / archiving to another location
+#                                       (By default export to origin config folder)
+#                [-f|--nofail]        - Don't stop on a failed build
+#                [-w|--nowarn]        - Suppress warnings with extra config options
+#                [-r|--reveal]        - Reveal the config/export folder after the build
+#                [-h|--help]          - Print usage and exit
+#                [--allow]            - Allow this script to run standalone
+#
+
+usage() { echo "Usage:
+
+build_example  -b|--base=<path>    - Configurations root folder (e.g., ./.pio/build-BRANCH)
+               -c|--config=<rel>   - Sub-path of the configs to build (within config/examples)
+              [-e|--export=N]      - Use CONFIG_EXPORT N to export the config to the export location
+              [-a|--archive]       - Archive the build (to the export location)
+              [-o|--output]        - Redirect export / archiving to another location
+                                     (By default export to origin config folder)
+              [-f|--nofail]        - Don't stop on a failed build
+              [-w|--nowarn]        - Suppress warnings with extra config options
+              [-r|--reveal]        - Reveal the config/export folder after the build
+              [-h|--help]          - Print usage and exit
+              [--allow]            - Allow this script to run standalone
+"
+}
+
+HERE=`dirname $0`
+PATH="$HERE:$PATH"
+
+. mfutil
+
+annc() { echo -e "\033[0;32m$1\033[0m" ; }
+alrt() { echo -e "\033[0;31m$1\033[0m" ; }
+
+# Get arguments
+BUILD=./.pio/build
+CLEANER=
+ALLOW=
+ARCHIVE=
+BASE=
+CONFIG=
+REVEAL=
+EXPNUM=
+NOFAIL=
+OUTBASE=
+while getopts 'ab:c:e:fhio:r-:' OFLAG; do
+  case "${OFLAG}" in
+    a) ARCHIVE=1 ;;
+    b) BASE="${OPTARG%/}" ;;
+    c) CONFIG="${OPTARG%/}" ;;
+    e) EXPNUM="$OPTARG" ;;
+    o) OUTBASE="${OPTARG%/}" ;;
+    h) EXIT_USAGE=1 ; break ;;
+    f) NOFAIL=1 ;;
+    r) REVEAL=1 ;;
+    -) ONAM="${OPTARG%%=*}" ; OVAL="${OPTARG#*=}"
+       case "$ONAM" in
+        archive) ARCHIVE=1 ;;
+          allow) ALLOW=1 ;;
+           base) BASE="${OVAL%/}" ;;
+         config) CONFIG="${OVAL%/}" ;;
+         export) EXPNUM="$OVAL" ;;
+         output) OUTBASE="${OVAL%/}" ;;
+           help) EXIT_USAGE=1 ; break ;;
+         nofail) NOFAIL=1 ;;
+         reveal) REVEAL=1 ;;
+              *) EXIT_USAGE=2 ; echo "$SELF: unrecognized option \`--$ONAM'" ; break ;;
+       esac
+       ;;
+    *) EXIT_USAGE=2 ; break ;;
+  esac
+done
+shift $((OPTIND - 1))
+
+# Must be called from another script (or with --allow)
+[[ $ALLOW || $SHLVL -gt 2 ]] || { echo "Don't call this script directly, use build_all_examples instead." ; exit 1 ; }
+
+# Exit with helpful usage information
+((EXIT_USAGE)) && { usage ; let EXIT_USAGE-- ; exit $EXIT_USAGE ; }
+
+# -b|--base and -c|--config are required
+[[ -z $BASE ]] && { echo "-b|--base is required" ; exit 1 ; }
+[[ -z $CONFIG ]] && { echo "-c|--config is required" ; exit 1 ; }
+
+# Expand ~ to $HOME in provided arguments
+BASE=${BASE/#\~/$HOME}
+CONFIG=${CONFIG/#\~/$HOME}
+
+# Make sure the examples exist
+SUB1="$BASE/config/examples"
+[[ -d "$SUB1" ]] || { echo "-b|--base $BASE doesn't contain config/examples" ; exit 1 ; }
+
+# Make sure the specific config folder exists
+SUB="$SUB1/$CONFIG"
+[[ -d "$SUB" ]] || { echo "-c|--config $CONFIG doesn't exist" ; exit 1 ; }
+
+# ...and contains Configuration.h or Configuration_adv.h
+[[ -f "$SUB"/Configuration.h  || -f "$SUB"/Configuration_adv.h ]] || { echo "No configuration files found in $SUB" ; exit 1 ; }
+
+# Get the location for exports and archives
+if [[ -n $OUTBASE ]]; then
+  ARCSUB="${OUTBASE/#\~/$HOME}/$CONFIG"
+  mkdir -p "$ARCSUB"
+else
+  ARCSUB="$SUB"
+fi
+
+# Delete any config files from previous builds
+rm -f Marlin/_Bootscreen.h Marlin/_Statusscreen.h
+
+# Copy configurations into the Marlin folder
+echo "Getting configuration files from $SUB"
+cp "$BASE"/config/default/*.h Marlin/
+cp "$SUB"/*.h Marlin/
+
+rm -f Marlin/Config.h Marlin/Config-export.h
+
+set -e
+
+# Strip #error lines from Configuration.h using
+awk 'NR < 20 || NR > 30 || !/#error/' Marlin/Configuration.h > Marlin/Configuration.h~
+mv Marlin/Configuration.h~ Marlin/Configuration.h
+
+# Hide several warnings when not exporting
+[[ -z $EXPNUM ]] && CLEANER=1
+
+# Suppress fatal warnings
+if ((CLEANER)); then
+  opt_add NO_CONTROLLER_CUSTOM_WIRING_WARNING
+  opt_add NO_AUTO_ASSIGN_WARNING
+  opt_add NO_CREALITY_DRIVER_WARNING
+  opt_add DIAG_JUMPERS_REMOVED
+  opt_add DIAG_PINS_REMOVED
+  opt_add NO_MK3_FAN_PINS_WARNING
+  opt_add NO_USER_FEEDBACK_WARNING
+  opt_add NO_Z_SAFE_HOMING_WARNING
+  opt_add NO_LCD_CONTRAST_WARNING
+  opt_add NO_MICROPROBE_WARNING
+  opt_add NO_CONFIGURATION_EMBEDDING_WARNING
+  opt_add NO_HOMING_CURRENT_WARNING
+fi
+
+# Possible exported file names (in the build folder)
+ENAME=("-name" "marlin_config.json" \
+  "-o" "-name" "config.ini" \
+  "-o" "-name" "schema.json" \
+  "-o" "-name" "schema.yml")
+
+# Possible built firmware names (in the build folder)
+BNAME=("-name" 'firmware*.hex' \
+  "-o" "-name" "firmware*.bin" \
+  "-o" "-name" "project*.bin" \
+  "-o" "-name" "Robin*.bin" \
+  "-o" "-name" "main_*.bin")
+
+mkdir -p "$BUILD"
+
+# If EXPNUM is set then apply to the config before build
+if [[ $EXPNUM ]]; then
+  opt_set CONFIG_EXPORT $EXPNUM
+  # Clean up old exports
+  find "$BUILD" \( "${ENAME[@]}" \) -exec rm "{}" \;
+fi
+
+((ARCHIVE)) && find "$BUILD" \( "${BNAME[@]}" \) -exec rm "{}" \;
+
+set +e
+
+echo "Building example $CONFIG ..."
+mftest -s -a -n1 ; ERR=$?
+
+((ERR)) && alrt "Failed ($ERR)" || annc "Success"
+
+set -e
+
+if [[ $ERR -gt 0 ]]; then
+
+  # Error? For --nofail simply log. Otherwise return the error.
+  if [[ -n $NOFAIL ]]; then
+    date +"%F %T [FAIL] $CONFIG" >>./.pio/error-log.txt
+  else
+    exit $ERR
+  fi
+
+else
+
+  # Copy exports back to the configs
+  if [[ -n $EXPNUM ]]; then
+    annc "Exporting $EXPNUM"
+    [[ -f Marlin/Config-export.h ]] && { cp Marlin/Config-export.h "$ARCSUB"/Config.h ; }
+    find "$BUILD" \( "${ENAME[@]}" \) -exec cp "{}" "$ARCSUB" \;
+  fi
+
+  # Copy potential firmware files into the config folder
+  # TODO: Consider firmware that needs an STM32F4_UPDATE folder.
+  #       Currently only BOARD_CREALITY_F401RE env:STM32F401RE_creality
+  if ((ARCHIVE)); then
+    annc "Archiving"
+    rm -f "$ARCSUB"/*.bin.tar.gz "$ARCSUB"/*.hex.tar.gz
+    find "$BUILD" \( "${BNAME[@]}" \) -exec sh -c '
+      ARCSUB="$1"
+      CONFIG="$2"
+      shift 2
+      for FILE in "$@"; do
+        cd "${FILE%/*}"
+        NAME=${FILE##*/}
+        SHRT=${NAME%.*}
+        SHASUM=$(sha256sum "$NAME" | cut -d" " -f1)
+        tar -czf "$ARCSUB/$SHRT.tar.gz" "$NAME"
+        echo "$CONFIG\n$SHASUM" > "$ARCSUB/$NAME.sha256.txt"
+        rm "$NAME"
+        cd - >/dev/null
+      done
+    ' sh "$ARCSUB" "$CONFIG" {} +
+  fi
+
+  # Reveal the configs after the build, if requested
+  ((REVEAL)) && { annc "Revealing $ARCSUB" ; open "$ARCSUB" ; }
+
+fi
+
+exit 0

buildroot/bin/ci_src_filter

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+# exit on first failure
+set -e
+
+FN="platformio.ini"
+
+if [[ $1 == "-n" ]]; then
+  awk '/default_src_filter/ { sub("default_src_filter", "org_src_filter"); print "default_src_filter = +<src/*>"; } 1' $FN > $FN~ && mv $FN~ $FN
+else
+  git checkout $FN 2>/dev/null
+fi

buildroot/bin/config.py

@@ -0,0 +1,96 @@
+'''
+config.py - Helper functions for config manipulation
+'''
+import re
+
+FILES = ('Marlin/Configuration.h', 'Marlin/Configuration_adv.h')
+
+def set(file_path, define_name, value):
+    '''
+    Replaces a define in a file with a new value.
+    Returns True if the define was found and replaced, False otherwise.
+    '''
+    # Read the contents of the file
+    with open(file_path, 'r') as f:
+        content = f.readlines()
+
+    modified = False
+    for i in range(len(content)):
+        # Regex to match the desired pattern
+        match = re.match(r'^(\s*)(/*)(\s*)(#define\s+{})\s+(.*)$'.format(re.escape(define_name)), content[i])
+        if match:
+            new_line = f"{match[1]}{match[3]}{match[4]} {value} // {match[5]}\n"
+            content[i] = new_line
+            modified = True
+
+    # Write the modified content back to the file only if changes were made
+    if modified:
+        with open(file_path, 'w') as f:
+            f.writelines(content)
+        return True
+
+    return False
+
+def add(file_path, define_name, value=""):
+    '''
+    Insert a define on the first blank line in a file.
+    Returns True if the define was found and replaced, False otherwise.
+    '''
+    with open(file_path, 'r') as f:
+        content = f.readlines()
+
+    # Prepend a space to the value if it's not empty
+    if value != "":
+        value = " " + value
+
+    # Find the first blank line to insert the new define
+    for i in range(len(content)):
+        if content[i].strip() == '':
+            # Insert the define at the first blank line
+            content.insert(i, f"#define {define_name}{value}\n")
+            break
+    else:
+        # If no blank line is found, append to the end
+        content.append(f"#define {define_name}{value}\n")
+
+    with open(file_path, 'w') as f:
+        f.writelines(content)
+
+def enable(file_path, define_name, enable=True):
+    '''
+    Uncomment or comment the named defines in the given file path.
+    Returns True if the define was found, False otherwise.
+    '''
+    # Read the contents of the file
+    with open(file_path, 'r') as f:
+        content = f.readlines()
+
+    # Prepare the regex
+    regex = re.compile(r'^(\s*)(/*)(\s*)(#define\s+{}\b.*?)( *//.*)?$'.format(re.escape(define_name)))
+
+    # Find the define in the file and uncomment or comment it
+    found = False
+    modified = False
+    for i in range(len(content)):
+        match = regex.match(content[i])
+        if not match: continue
+        found = True
+        if enable:
+            if match[2]:
+                modified = True
+                comment = '' if match[5] is None else '  ' + match[5]
+                content[i] = f"{match[1]}{match[3]}{match[4]}{comment}\n"
+        else:
+            if not match[2]:
+                modified = True
+                comment = '' if match[5] is None else match[5]
+                if comment.startswith('  '): comment = comment[2:]
+                content[i] = f"{match[1]}//{match[3]}{match[4]}{comment}\n"
+        break
+
+    # Write the modified content back to the file only if changes were made
+    if modified:
+        with open(file_path, 'w') as f:
+            f.writelines(content)
+
+    return found

buildroot/bin/format_code

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+#
+# format_code [dir/file...]
+#
+
+HERE=`dirname $0`
+
+while [[ $# -gt 0 ]]; do
+
+  val="$1"
+
+  if [ -d "$val" ]; then
+
+    find $val -name *.cpp -exec "$HERE/uncrust" '{}' \;
+
+  elif [ -d "./Marlin/src/$val" ]; then
+
+    find "./Marlin/src/$val" -name *.cpp -exec "$HERE/uncrust" '{}' \;
+
+  elif [ -f "./Marlin/src/$val" ]; then
+
+    uncrust "./Marlin/src/$val"
+
+  elif [ -f "$val" ]; then
+
+    uncrust "$val"
+
+  fi
+
+done

buildroot/bin/generate_version

@@ -0,0 +1,117 @@
+#!/usr/bin/env bash
+#
+# generate_version
+#
+# Make a Version.h file to accompany CUSTOM_VERSION_FILE
+#
+# Authors: jbrazio, thinkyhead, InsanityAutomation, rfinnie
+#
+
+set -e
+
+DIR="${1:-Marlin}"
+READ_FILE="${READ_FILE:-${DIR}/Version.h}"
+WRITE_FILE="${WRITE_FILE:-${READ_FILE}}"
+
+BRANCH="$(git -C "${DIR}" symbolic-ref -q --short HEAD 2>/dev/null || true)"
+VERSION="$(git -C "${DIR}" describe --tags --first-parent 2>/dev/null || true)"
+
+STRING_DISTRIBUTION_DATE="${STRING_DISTRIBUTION_DATE:-$(date '+%Y-%m-%d %H:%M')}"
+SHORT_BUILD_VERSION="${SHORT_BUILD_VERSION:-${BRANCH}}"
+DETAILED_BUILD_VERSION="${DETAILED_BUILD_VERSION:-${BRANCH}-${VERSION}}"
+PROTOCOL_VERSION="1.0"
+
+# Gets some misc options from their defaults
+DEFAULT_MACHINE_UUID="${DEFAULT_MACHINE_UUID:-$(awk -F'"' \
+  '/#define DEFAULT_MACHINE_UUID/{ print $2 }' < "${READ_FILE}")}"
+MACHINE_NAME="${MACHINE_NAME:-$(awk -F'"' \
+  '/#define MACHINE_NAME/{ print $2 }' < "${READ_FILE}")}"
+PROTOCOL_VERSION="${PROTOCOL_VERSION:-$(awk -F'"' \
+  '/#define PROTOCOL_VERSION/{ print $2 }' < "${READ_FILE}")}"
+SOURCE_CODE_URL="${SOURCE_CODE_URL:-$(awk -F'"' \
+  '/#define SOURCE_CODE_URL/{ print $2 }' < "${READ_FILE}")}"
+WEBSITE_URL="${WEBSITE_URL:-$(awk -F'"' \
+  '/#define WEBSITE_URL/{ print $2 }' < "${READ_FILE}")}"
+
+cat > "${WRITE_FILE}" <<EOF
+/**
+ * Marlin 3D Printer Firmware
+ * Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
+ *
+ * Based on Sprinter and grbl.
+ * Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+#pragma once
+
+/**
+ * THIS FILE IS AUTOMATICALLY GENERATED DO NOT MANUALLY EDIT IT.
+ * IT DOES NOT GET COMMITTED TO THE REPOSITORY.
+ *
+ * Branch: ${BRANCH}
+ * Version: ${VERSION}
+ */
+
+/**
+ * Marlin release version identifier
+ */
+#define SHORT_BUILD_VERSION "${SHORT_BUILD_VERSION}"
+
+/**
+ * Verbose version identifier which should contain a reference to the location
+ * from where the binary was downloaded or the source code was compiled.
+ */
+#define DETAILED_BUILD_VERSION "${DETAILED_BUILD_VERSION}"
+
+/**
+ * The STRING_DISTRIBUTION_DATE represents when the binary file was built,
+ * here we define this default string as the date where the latest release
+ * version was tagged.
+ */
+#define STRING_DISTRIBUTION_DATE "${STRING_DISTRIBUTION_DATE}"
+
+/**
+ * The protocol for communication to the host. Protocol indicates communication
+ * standards such as the use of ASCII, "echo:" and "error:" line prefixes, etc.
+ * (Other behaviors are given by the firmware version and capabilities report.)
+ */
+#define PROTOCOL_VERSION "${PROTOCOL_VERSION}"
+
+/**
+ * Defines a generic printer name to be output to the LCD after booting Marlin.
+ */
+#define MACHINE_NAME "${MACHINE_NAME}"
+
+/**
+ * The SOURCE_CODE_URL is the location where users will find the Marlin Source
+ * Code which is installed on the device. In most cases —unless the manufacturer
+ * has a distinct Github fork— the Source Code URL should just be the main
+ * Marlin repository.
+ */
+#define SOURCE_CODE_URL "${SOURCE_CODE_URL}"
+
+/**
+ * Default generic printer UUID.
+ */
+#define DEFAULT_MACHINE_UUID "${DEFAULT_MACHINE_UUID}"
+
+/**
+ * The WEBSITE_URL is the location where users can get more information such as
+ * documentation about a specific Marlin release.
+ */
+#define WEBSITE_URL "${WEBSITE_URL}"
+
+EOF

buildroot/bin/mftest

@@ -0,0 +1,349 @@
+#!/usr/bin/env bash
+#
+#  mftest                             Select a test to apply and build
+#  mftest -b [#]                      Build the auto-detected environment
+#  mftest -u [#]                      Upload the auto-detected environment
+#  mftest -tname -n# [-y]             Set config options and optionally build a test
+#
+
+[[ -d Marlin/src ]] || { echo "Please 'cd' to the Marlin repo root." ; exit 1 ; }
+
+which pio >/dev/null || { echo "Make sure 'pio' is in your execution PATH." ; exit 1 ;  }
+
+perror() { echo -e "$0: \033[0;31m$1 -- $2\033[0m" ; }
+errout() { echo -e "\033[0;31m$1\033[0m" ; }
+bugout() { ((DEBUG)) && echo -e "\033[0;32m$1\033[0m" ; }
+
+usage() {
+  echo "
+Usage: mftest [-t|--env=<env|index>] [-n|--num=<num>] [-m|--make] [-y|--build=<Y|n>]
+       mftest [-a|--autobuild]
+       mftest [-r|--rebuild]
+       mftest [-s|--silent]
+       mftest [-u|--autoupload] [-n|--num=<num>]
+
+OPTIONS
+  -t --env         The environment to apply / run, or the menu index number.
+  -n --num         The index of the test to run. (In file order.)
+  -m --make        Use the make / Docker method for the build.
+  -y --build       Skip 'Do you want to build this test?' and assume YES.
+  -h --help        Print this help.
+  -a --autobuild   PIO Build using the MOTHERBOARD environment.
+  -u --autoupload  PIO Upload using the MOTHERBOARD environment.
+  -v --verbose     Extra output for debugging.
+  -s --silent      Silence build output from PlatformIO.
+  -d --default     Restore to defaults before applying configs.
+
+env shortcuts: tree due esp lin lp8|lpc8 lp9|lpc9 m128 m256|mega stm|f1 f4 f7 s6 teensy|t31|t32 t35|t36 t40|t41
+"
+}
+
+TESTPATH=buildroot/tests
+
+STATE_FILE="./.pio/.mftestrc"
+
+shopt -s extglob nocasematch
+
+# Matching patterns
+ISNUM='^[0-9]+$'
+ISRST='^(restore)_'
+ISCMD='^(restore|opt|exec|use|pins|env)_'
+ISEXEC='^exec_'
+ISCONT='\\ *$'
+
+# Get environment, test number, etc. from the command
+TESTENV='-'
+CHOICE=0
+DEBUG=0
+
+while getopts 'abdhmrsuvyn:t:-:' OFLAG; do
+  case "${OFLAG}" in
+    a) AUTO_BUILD=1 ; bugout "Auto-Build target..." ;;
+    d) DL_DEFAULTS=1 ; bugout "Restore to defaults..." ;;
+    h) EXIT_USAGE=1 ;;
+    m) USE_MAKE=1 ; bugout "Using make with Docker..." ;;
+    n) case "$OPTARG" in
+         *[!0-9]*) perror "option requires a number" $OFLAG ; EXIT_USAGE=2 ;;
+                *) CHOICE="$OPTARG" ; bugout "Got a number: $CHOICE" ;;
+       esac
+       ;;
+    r) REBUILD=1         ; bugout "Rebuilding previous..." ;;
+    s) SILENT_FLAG="-s" ;;
+    t) TESTENV="$OPTARG" ; bugout "Got a target: $TESTENV" ;;
+    u) AUTO_BUILD=2      ; bugout "Auto-Upload target..." ;;
+    v) DEBUG=1           ; bugout "Debug ON" ;;
+    y) BUILD_YES='Y'     ; bugout "Build will initiate..." ;;
+    -) ONAM="${OPTARG%%=*}" ; OVAL="${OPTARG#*=}"
+       case "$ONAM" in
+         help) [[ -z "$OVAL" ]] || perror "option can't take value $OVAL" $ONAM ; EXIT_USAGE=1 ;;
+    autobuild) AUTO_BUILD=1 ; bugout "Auto-Build target..."  ;;
+   autoupload) AUTO_BUILD=2 ; bugout "Auto-Upload target..." ;;
+          env) case "$OVAL" in
+                 '') perror "option requires a value" $ONAM ; EXIT_USAGE=2 ;;
+                  *) TESTENV="$OVAL" ; bugout "Got a target: $TESTENV" ;;
+               esac
+               ;;
+          num) case "$OVAL" in
+                 [0-9]+) CHOICE="$OVAL" ; bugout "Got a number: $CHOICE" ;;
+                      *) perror "option requires a value" $ONAM ; EXIT_USAGE=2 ;;
+               esac
+               ;;
+      rebuild) REBUILD=1  ; bugout "Rebuilding previous..." ;;
+       silent) SILENT_FLAG="-s" ;;
+         make) USE_MAKE=1 ; bugout "Using make with Docker..." ;;
+debug|verbose) DEBUG=1    ; bugout "Debug ON" ;;
+      default) DL_DEFAULTS=1 ; bugout "Restore to defaults..." ;;
+        build) case "$OVAL" in
+                 ''|y|yes) BUILD_YES='Y' ;;
+                     n|no) BUILD_YES='N' ;;
+                        *) perror "option value must be y, n, yes, or no" $ONAM ; EXIT_USAGE=2 ;;
+               esac
+               bugout "Build will initiate? ($BUILD_YES)"
+               ;;
+            *) perror "Unknown flag" "$OPTARG" ; EXIT_USAGE=2 ;;
+       esac
+       ;;
+    *) EXIT_USAGE=2 ;;
+  esac
+done
+shift $((OPTIND - 1))
+
+((EXIT_USAGE)) && { usage ; let EXIT_USAGE-- ; exit $EXIT_USAGE ; }
+
+if ((REBUILD)); then
+  bugout "Rebuilding previous..."
+  # Build with the last-built env
+  [[ -f "$STATE_FILE" ]] || { errout "No previous (-r) build state found." ; exit 1 ; }
+  read TESTENV <"$STATE_FILE"
+  pio run $SILENT_FLAG -d . -e $TESTENV
+  exit 0
+fi
+
+case $TESTENV in
+    tree) pio run -d . -e include_tree ; exit 1 ;;
+     due) TESTENV='DUE' ;;
+     esp) TESTENV='esp32' ;;
+    lin*) TESTENV='linux_native' ;;
+lp8|lpc8) TESTENV='LPC1768' ;;
+lp9|lpc9) TESTENV='LPC1769' ;;
+    m128) TESTENV='mega1280' ;;
+    m256) TESTENV='mega2560' ;;
+    mega) TESTENV='mega2560' ;;
+     stm) TESTENV='STM32F103RE' ;;
+      f1) TESTENV='STM32F103RE' ;;
+      f4) TESTENV='STM32F4' ;;
+      f7) TESTENV='STM32F7' ;;
+      s6) TESTENV='FYSETC_S6' ;;
+  teensy) TESTENV='teensy31' ;;
+     t31) TESTENV='teensy31' ;;
+     t32) TESTENV='teensy31' ;;
+     t35) TESTENV='teensy35' ;;
+     t36) TESTENV='teensy35' ;;
+     t40) TESTENV='teensy41' ;;
+     t41) TESTENV='teensy41' ;;
+[1-9]|[1-9][0-9]) TESTNUM=$TESTENV ; TESTENV=- ;;
+esac
+
+if ((AUTO_BUILD)); then
+  #
+  # List environments that apply to the current MOTHERBOARD.
+  #
+  case $(uname | tr '[:upper:]' '[:lower:]') in
+    darwin) SYS='mac' ;;
+    *linux) SYS='lin' ;;
+      win*) SYS='win' ;;
+     msys*) SYS='win' ;;
+   cygwin*) SYS='win' ;;
+    mingw*) SYS='win' ;;
+         *) SYS='uni' ;;
+  esac
+  echo ; echo -n "Auto " ; ((AUTO_BUILD == 2)) && echo "Upload..." || echo "Build..."
+
+  #
+  # Get the MOTHERBOARD define value from the .h file and strip off the "BOARD_" prefix
+  #
+  ACODE='/^[[:space:]]*#define[[:space:]]MOTHERBOARD[[:space:]]/ { sub(/^BOARD_/, "", $3); print $3 }'
+  MB=$(awk "$ACODE" Marlin/Configuration.h 2>/dev/null)
+  [[ -z $MB ]] && MB=$(awk "$ACODE" Marlin/Config.h 2>/dev/null)
+  [[ -z $MB ]] && { echo "Error - Can't read MOTHERBOARD setting." ; exit 1 ; }
+  BLINE=$( grep -E "define\s+BOARD_$MB\b" Marlin/src/core/boards.h )
+  BNUM=$( sed -E 's/^.+BOARD_[^ ]+ +([0-9]+).+$/\1/' <<<"$BLINE" )
+  BDESC=$( sed -E 's/^.+\/\/ *(.+)$/\1/' <<<"$BLINE" )
+  [[ -z $BNUM ]] && { echo "Error - Can't find BOARD_$MB in core/boards.h." ; exit 1 ; }
+  ENVS=( $( grep -EA1 "MB\(.*\b$MB\b.*\)" Marlin/src/pins/pins.h | grep -E "#include.+//.+(env|$SYS):[^ ]+" | grep -oE "(env|$SYS):[^ ]+" | sed -E "s/(env|$SYS)://" ) )
+  [[ -z $ENVS ]] && { errout "Error - Can't find target(s) for $MB ($BNUM)." ; exit 1 ; }
+  ECOUNT=${#ENVS[*]}
+
+  if [[ $ECOUNT == 1 ]]; then
+    TARGET=$ENVS
+  else
+    if [[ $CHOICE == 0 ]]; then
+      # List env names and numbers. Get selection.
+      echo "Available targets for \"$BDESC\" | $MB ($BNUM):"
+
+      IND=0 ; for ENV in "${ENVS[@]}"; do let IND++ ; echo " $IND) $ENV" ; done
+
+      if [[ $ECOUNT > 1 ]]; then
+        for (( ; ; ))
+        do
+          read -p "Select a target for '$MB' (1-$ECOUNT) : " CHOICE
+          [[ -z "$CHOICE" ]] && { echo '(canceled)' ; exit 1 ; }
+          [[ $CHOICE =~ $ISNUM ]] && ((CHOICE >= 1 && CHOICE <= ECOUNT)) && break
+          errout ">>> Invalid environment choice '$CHOICE'."
+        done
+        echo
+      fi
+    else
+      echo "Detected \"$BDESC\" | $MB ($BNUM)."
+      [[ $CHOICE > $ECOUNT ]] && { echo "Environment selection out of range." ; exit 1 ; }
+    fi
+    TARGET="${ENVS[$CHOICE-1]}"
+    if [[ $MB == 'SIMULATED' && $TARGET == 'linux_native' ]]; then
+      TARGET="simulator_linux_release" # Skip the linux_native environment
+    fi
+    echo "Selected $TARGET"
+  fi
+
+  echo "$TARGET" >"$STATE_FILE"
+
+  if ((AUTO_BUILD == 2)); then
+    echo "Uploading environment $TARGET for board $MB ($BNUM)..." ; echo
+    pio run $SILENT_FLAG -t upload -e $TARGET
+  else
+    echo "Building environment $TARGET for board $MB ($BNUM)..." ; echo
+    pio run $SILENT_FLAG -e $TARGET
+  fi
+  exit $?
+fi
+
+#
+# List available tests and ask for selection
+#
+
+if [[ $TESTENV == '-' ]]; then
+  IND=0
+  NAMES=()
+  MENU=()
+  BIGLEN=0
+  for FILE in $( ls -1 $TESTPATH/* | sort -f )
+  do
+    let IND++
+    TNAME=${FILE/$TESTPATH\//}
+    NAMES+=($TNAME)
+    IFS=""
+    ITEM=$( printf "%2i) %s" $IND $TNAME )
+    MENU+=($ITEM)
+    [[ ${#ITEM} -gt $BIGLEN ]] && BIGLEN=${#ITEM}
+  done
+
+  (( BIGLEN += 2 ))
+  THIRD=$(( (${#MENU[@]} + 2) / 3 ))
+  for ((i = 0; i < $THIRD; i++))
+  do
+    COL1=$i ; COL2=$(( $i + $THIRD )) ; COL3=$(( $i + 2 * $THIRD ))
+    FMT="%-${BIGLEN}s"
+    printf "${FMT}${FMT}${FMT}\n" ${MENU[$COL1]} ${MENU[$COL2]} ${MENU[$COL3]}
+  done
+
+  echo
+  for (( ; ; ))
+  do
+    if [[ $TESTNUM -gt 0 ]]; then
+      NAMEIND=$TESTNUM
+    else
+      read -p "Select a test to apply (1-$IND) : " NAMEIND
+    fi
+    [[ -z $NAMEIND ]] && { errout "(canceled)" ; exit 1 ; }
+    TESTENV=${NAMES[$NAMEIND-1]}
+    [[ $TESTNUM -gt 0 ]] && { echo "Preselected test $TESTNUM ... ($TESTENV)" ; TESTNUM='' ; }
+    [[ $NAMEIND =~ $ISNUM ]] && ((NAMEIND >= 1 && NAMEIND <= IND)) && { TESTENV=${NAMES[$NAMEIND-1]} ; echo ; break ; }
+    errout "Invalid selection."
+  done
+fi
+
+# Get the contents of the test file
+OUT=$( cat $TESTPATH/$TESTENV 2>/dev/null ) || { errout "Can't find test '$TESTENV'." ; exit 1 ; }
+
+# Count up the number of tests
+TESTCOUNT=$( awk "/$ISEXEC/{a++}END{print a}" <<<"$OUT" )
+
+# User entered a number?
+(( CHOICE && CHOICE > TESTCOUNT )) && { errout "Invalid test selection '$CHOICE' (1-$TESTCOUNT)." ; exit 1 ; }
+
+if [[ $CHOICE == 0 ]]; then
+  #
+  # List test descriptions with numbers and get selection
+  #
+  echo "Available '$TESTENV' tests:" ; echo "$OUT" | {
+    IND=0
+    while IFS= read -r LINE
+    do
+      if [[ $LINE =~ $ISEXEC ]]; then
+        DESC=$( sed -E 's/^exec_test \$1 \$2 "([^"]+)".*$/\1/g' <<<"$LINE" )
+        (( ++IND < 10 )) && echo -n " "
+        echo " $IND) $DESC"
+      fi
+    done
+  }
+  CHOICE=1
+  if [[ $TESTCOUNT > 1 ]]; then
+    for (( ; ; ))
+    do
+      read -p "Select a '$TESTENV' test (1-$TESTCOUNT) : " CHOICE
+      [[ -z "$CHOICE" ]] && { errout "(canceled)" ; exit 1 ; }
+      [[ $CHOICE =~ $ISNUM ]] && ((CHOICE >= 1 && CHOICE <= TESTCOUNT)) && break
+      errout ">>> Invalid test selection '$CHOICE'."
+    done
+  fi
+fi
+
+#
+# Restore to defaults if requested
+#
+((DL_DEFAULTS)) && use_example_configs
+
+#
+# Run the specified test lines
+#
+echo -ne "\033[0;33m"
+echo "$OUT" | {
+  IND=0
+  GOTX=0
+  CMD=""
+  while IFS= read -r LINE
+  do
+    if [[ $LINE =~ $ISCMD || $GOTX == 1 ]]; then
+      ((!IND)) && let IND++
+      if [[ $LINE =~ $ISEXEC ]]; then
+        ((IND++ > CHOICE)) && break
+      else
+        ((!HEADER)) && {
+          HEADER=1
+          echo -e "\n#\n# Test $TESTENV ($CHOICE) $DESC\n#"
+        }
+        ((IND == CHOICE)) && {
+          GOTX=1
+          [[ -n $DL_DEFAULTS && $LINE =~ $ISRST ]] && LINE="use_example_configs"
+          [[ $CMD == "" ]] && CMD="$LINE" || CMD=$( echo -e "$CMD$LINE" | sed -e 's/\\//g' | sed -E 's/ +/ /g' )
+          [[ $LINE =~ $ISCONT ]] || { echo "$CMD" ; eval "$CMD" ; CMD="" ; }
+        }
+      fi
+    fi
+  done
+}
+echo -ne "\033[0m"
+
+# Make clear it's a TEST
+opt_set CUSTOM_MACHINE_NAME "\"Test $TESTENV ($CHOICE)\""
+
+# Build the test too?
+if [[ -z "$BUILD_YES" ]]; then
+  echo
+  read -p "Build $TESTENV test #$CHOICE (y/N) ? " BUILD_YES
+fi
+
+[[ $BUILD_YES == 'Y' || $BUILD_YES == 'Yes' ]] && {
+  ((USE_MAKE)) && make tests-single-local TEST_TARGET=$TESTENV ONLY_TEST=$CHOICE
+  ((USE_MAKE)) || pio run $SILENT_FLAG -d . -e $TESTENV
+  echo "$TESTENV" >"$STATE_FILE"
+}

buildroot/bin/mfutil

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+#
+# mfutil - check env and define helpers
+#
+
+# Check dependencies
+which curl &>/dev/null || { echo "curl not found! Please install it."; exit 1 ; }
+which git  &>/dev/null || { echo "git not found! Please install it."; exit 1 ; }
+which sed  &>/dev/null || { echo "sed not found! Please install it."; exit 1 ; }
+
+OPEN=$( which gnome-open xdg-open open | head -n1 )
+
+SELF=`basename "$0"`
+
+# Check if called in the right location
+[[ -e "Marlin/src" ]] || { echo -e "This script must be called from a Marlin working copy with:\n ./buildroot/bin/$SELF $1" ; exit ; }
+
+perror() { echo -e "$0: \033[0;31m$1 -- $2\033[0m" ; }
+bugout() { ((DEBUG)) && echo -e "\033[0;32m$1\033[0m" ; }

buildroot/bin/opt_add

@@ -0,0 +1,11 @@
+#!/usr/bin/env python
+
+import sys, config
+
+def main():
+    args = sys.argv[1:]
+    for name in args:
+        config.add(config.FILES[0], name)
+
+if __name__ == "__main__":
+    main()

buildroot/bin/opt_disable

@@ -0,0 +1,21 @@
+#!/usr/bin/env python
+
+import sys, os,config
+
+def main():
+    args = sys.argv[1:]
+
+    for name in args:
+        changed = False
+
+        for file in config.FILES:
+            if os.path.exists(file):
+                if config.enable(file, name, False):
+                    changed = True
+
+        if not changed:
+            print(f"ERROR: Can't find {name}")
+            exit(1)
+
+if __name__ == "__main__":
+    main()

buildroot/bin/opt_enable

@@ -0,0 +1,21 @@
+#!/usr/bin/env python
+
+import sys, os,config
+
+def main():
+    args = sys.argv[1:]
+
+    for name in args:
+        changed = False
+
+        for file in config.FILES:
+            if os.path.exists(file):
+                if config.enable(file, name):
+                    changed = True
+
+        if not changed:
+            print(f"ERROR: Can't find {name}")
+            exit(1)
+
+if __name__ == "__main__":
+    main()

buildroot/bin/opt_find

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+#
+# opt_find
+# Find one or more Marlin options - Configuration lines starting with #define
+#
+
+MYNAME=$(basename $0)
+
+[[ $# == 0 ]] && ONE="-h" || ONE=$1
+
+COMM="(//\\s*)?" ; TYPE=""
+case "$ONE" in
+  -d|--disabled )
+      shift ; COMM="(//\\s*)" ; TYPE="disabled " ;;
+  -e|--enabled )
+      shift ; COMM="" ; TYPE="enabled " ;;
+  -h|--help )
+      echo "$MYNAME [-d|--disabled|-e|--enabled] STRING ... Find matching Marlin configuration options."
+      echo ; shift ;;
+  -* )
+      echo "Unknown option $ONE" ; shift ;;
+esac
+
+while [[ $# > 0 ]]; do
+  DID=0
+  for FN in Marlin/Configuration.h Marlin/Configuration_adv.h; do
+    FOUND=$( grep -HEn "^\s*${COMM}#define\s+[A-Z0-9_]*${1}" $FN 2>/dev/null )
+    [[ -n "$FOUND" ]] && { echo "$FOUND" ; DID=1 ; }
+  done
+  ((DID)) || { echo "ERROR: ${MYNAME} - No ${TYPE}match for ${1}" ; exit 9; }
+  shift
+  echo
+done

buildroot/bin/opt_set

@@ -0,0 +1,25 @@
+#!/usr/bin/env python
+
+import sys, os, config
+
+def main():
+    args = sys.argv[1:]
+    if len(args) % 2 != 0:
+        print("ERROR: Please provide pairs of <name> <value>")
+        return
+
+    for i in range(0, len(args), 2):
+        name = args[i]
+        value = args[i + 1]
+        changed = False
+
+        for file in config.FILES:
+            if os.path.exists(file):
+                if config.set(file, name, value):
+                    changed = True
+
+        if not changed:
+            config.add(config.FILES[0], name, value)
+
+if __name__ == "__main__":
+    main()

buildroot/bin/restore_configs

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+rm -f Marlin/_Bootscreen.h Marlin/_Statusscreen.h marlin_config.json .pio/build/mc.zip
+
+if [[ $1 == '-d' || $1 == '--default' ]]; then
+  use_example_configs
+else
+  git checkout Marlin/Configuration.h 2>/dev/null
+  git checkout Marlin/Configuration_adv.h 2>/dev/null
+  git checkout Marlin/config.ini 2>/dev/null
+  git checkout Marlin/src/pins/*/pins_*.h 2>/dev/null
+fi

buildroot/bin/run_tests

@@ -0,0 +1,77 @@
+#!/usr/bin/env bash
+#
+# run_tests
+#
+HERE="$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P )"
+TESTS="$HERE/../tests"
+export PATH="$HERE:$TESTS:$PATH"
+
+# exit on first failure
+set -e
+
+exec_test () {
+  printf "\n\033[0;32m[Test $2] \033[0m$3...\n"
+  # Check to see if we should skip tests
+  if [[ -n "$4" ]] ; then
+    if [[ ! "$3" =~ $4 ]] ; then
+      printf "\033[1;33mSkipped\033[0m\n"
+      return 0
+    fi
+  fi
+  if [[ -z "$VERBOSE_PLATFORMIO" ]] ; then
+    silent="--silent"
+  else
+    silent="-v"
+  fi
+  if platformio run --project-dir $1 -e $2 $silent; then
+    printf "\033[0;32mPassed\033[0m\n"
+    return 0
+  else
+    if [[ -n $GIT_RESET_HARD ]]; then
+      git reset --hard HEAD
+    else
+      restore_configs
+    fi
+    printf "\033[0;31mFailed!\033[0m\n"
+    return 1
+  fi
+}
+export -f exec_test
+
+printf "Running \033[0;32m$2\033[0m Tests\n"
+
+if [[ $2 = "ALL" ]]; then
+  tests=("$TESTS"/*)
+  for f in "${tests[@]}"; do
+    testenv=$(basename $f)
+    printf "Running \033[0;32m$f\033[0m Tests\n"
+    exec_test $1 "$testenv --target clean" "Setup Build Environment"
+    if [[ $GIT_RESET_HARD == "true" ]]; then
+      git reset --hard HEAD
+    else
+      restore_configs
+    fi
+  done
+else
+  exec_test $1 "$2 --target clean" "Setup Build Environment"
+  test_name="$3"
+  # If the test name is 1 or 2 digits, treat it as an index
+  if [[ "$test_name" =~ ^[0-9][0-9]?$ ]] ; then
+    # Find the test name that corresponds to that index
+    test_name="$(cat $TESTS/$2 | grep -e '^exec_test' | sed -n "$3p" | sed "s/.*\$1 \$2 \"\([^\"]*\).*/\1/g")"
+    if [[ -z "$test_name" ]] ; then
+      # Fail if none matches
+      printf "\033[0;31mCould not find test \033[0m#$3\033[0;31m in \033[0mbuildroot/tests/$2\n"
+      exit 1
+    else
+      printf "\033[0;32mMatching test \033[0m#$3\033[0;32m: '\033[0m$test_name\033[0;32m'\n"
+    fi
+  fi
+  "$TESTS/$2" $1 $2 "$test_name"
+  if [[ $GIT_RESET_HARD == "true" ]]; then
+    git reset --hard HEAD
+  else
+    restore_configs
+  fi
+fi
+printf "\033[0;32mAll tests completed successfully\033[0m\n"

buildroot/bin/uncrust

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+#
+# Run uncrustify for a file in-place
+#
+
+TMPDIR=`mktemp -d`
+HERE=`dirname "$0"`
+
+# Reformat a single file to tmp/
+if uncrustify -l CPP -c "$HERE/../share/uncrustify/uncrustify.cfg" -f "$1" >$TMPDIR/uncrustify.out ; then
+  cp "$TMPDIR/uncrustify.out" "$1"  ; # Replace the original file
+else
+  echo "Something went wrong with uncrustify."
+fi
+
+# Clean up, deliberately
+[[ -f "$TMPDIR/uncrustify.out" ]] && rm "$TMPDIR/uncrustify.out"
+rmdir "$TMPDIR"

buildroot/bin/use_example_configs

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+#
+# use_example_configs [repo:]configpath
+#
+# Examples:
+#   use_example_configs
+#   use_example_configs Creality/CR-10/CrealityV1
+#   use_example_configs release-2.0.9.4:Creality/CR-10/CrealityV1
+#
+# If a configpath has spaces (or quotes) escape them or enquote the path
+# If no branch: prefix is given use configs based on the current branch name.
+# e.g., For `latest-2.1.x` name the working branch something like "my_work-2.1.x."
+#       The branch or tag must first exist at MarlinFirmware/Configurations.
+#       The fallback branch is bugfix-2.1.x.
+#
+
+which curl >/dev/null && TOOL='curl -L -s -S -f -o wgot'
+which wget >/dev/null && TOOL='wget -q -O wgot'
+
+CURR=$(git branch 2>/dev/null | grep ^* | sed 's/\* //g')
+case "$CURR" in
+   bugfix-2.*.x ) BRANCH=$CURR ;;
+  *-2.1.x|2.1.x ) BRANCH=latest-2.1.x ;;
+  *-2.0.x|2.0.x ) BRANCH=latest-2.0.x ;;
+  *-1.1.x|1.1.x ) BRANCH=latest-1.1.x ;;
+  *-1.0.x|1.0.x ) BRANCH=latest-1.0.x ;;
+              * ) BRANCH=bugfix-2.1.x ;;
+esac
+
+if [[ $# > 0 ]]; then
+  IFS=: read -r PART1 PART2 <<< "$@"
+  [[ -n $PART2 ]] && { UDIR="$PART2" ; BRANCH="$PART1" ; } \
+                  || { UDIR="$PART1" ; }
+  RDIR="${UDIR// /%20}"
+  echo "Fetching $UDIR configurations from $BRANCH..."
+  EXAMPLES="examples/$RDIR"
+else
+  EXAMPLES="default"
+fi
+
+CONFIGS="https://raw.githubusercontent.com/MarlinFirmware/Configurations/$BRANCH/config/${EXAMPLES}"
+
+restore_configs
+
+cd Marlin
+
+$TOOL "$CONFIGS/Configuration.h"     >/dev/null 2>&1 && mv wgot Configuration.h
+$TOOL "$CONFIGS/Configuration_adv.h" >/dev/null 2>&1 && mv wgot Configuration_adv.h
+$TOOL "$CONFIGS/_Bootscreen.h"       >/dev/null 2>&1 && mv wgot _Bootscreen.h
+$TOOL "$CONFIGS/_Statusscreen.h"     >/dev/null 2>&1 && mv wgot _Statusscreen.h
+
+rm -f wgot
+cd - >/dev/null