flash_your_device

#!/bin/bash
set -o errexit
set -o nounset
set -o pipefail

cleanup() {
  rm -rf -- "${temp_directory}"
  if [ "${machine}" == "Linux" ] &&
    [ -n "${initial_tty_device_permissions:-}" ] &&
    [ "$(stat -c '%a' "${tty_device}")" != "${initial_tty_device_permissions}" ]; then
    sudo chmod "${initial_tty_device_permissions}" "${tty_device}"
  fi
}

working_directory="${HOME}/Downloads/diy_jade"
temp_directory="${working_directory}/temp"
trap cleanup EXIT

jade_git_tag="1.0.30"
jade_save_directory="${working_directory}/jade"
jade_repo_url="https://github.com/blockstream/jade.git"

esp_idf_git_tag="v5.1.3"
esp_idf_temp_directory="${temp_directory}/esp-idf"
esp_idf_save_directory="${working_directory}/esp-idf"
esp_idf_repo_url="https://github.com/espressif/esp-idf.git"

device1="TTGO T-Display"
device2="M5Stack M5StickC PLUS"
device3="M5Stack Core Basic"
device4="M5Stack FIRE"

clear
echo "------------------------------------------------------------"
echo "------------------------------------------------------------"
echo "---                                                      ---"
echo "---          Do-It-Yourself Jade Install Script          ---"
echo "---                                                      ---"
echo "---       https://github.com/bitcoin-tools/diyjade       ---"
echo "---                                                      ---"
echo "------------------------------------------------------------"
echo "------------------------------------------------------------"
echo

if [ "$(whoami)" = "root" ]; then
  echo -e "ALERT: You're running the script as root/superuser.\nYou may notice PIP 'sudo -H' warnings.\n"
fi

case "$(uname -s)" in
Linux*)
  machine="Linux"
  echo "Detected ${machine}."
  echo -n "Checking for dependencies... "
  while read -r dependency; do
    if ! command -v "${dependency}" &> /dev/null; then
      echo -en "\n\nERROR:\n${dependency} was not found on your system.\nPlease install ${dependency} by running:\n\n"
      if [ "${dependency}" == "pip" ]; then
        echo -en "sudo apt update && sudo apt install -y python3-${dependency}\n\n"
      else
        echo -en "sudo apt update && sudo apt install -y ${dependency}\n\n"
      fi
      exit 1
    fi
  done < <(curl -fsSL https://github.com/bitcoin-tools/diyjade/raw/master/depends.txt)
  echo "ok."

  if grep -qEi '(debian|ubuntu)' /etc/os-release; then
    if ! dpkg -s python3-venv &> /dev/null; then
      echo -en "Package python3-venv is missing, please install by running:\n\n"
      echo -en "sudo apt update && sudo apt install -y python3-venv\n\n"
      exit 1
    fi
  fi

  ;;
Darwin*)
  machine="macOS"
  echo "Detected ${machine}."
  echo -n "Checking for cmake... "
  if ! command -v cmake &> /dev/null; then
    if [ ! -d /Applications/CMake.app ]; then
      cmake_macos_url="https://github.com/Kitware/CMake/releases/download/v3.26.4/cmake-3.26.4-macos-universal.dmg"
      cmake_macos_dmg="$(basename ${cmake_macos_url})"

      if [ ! -f "${HOME}"/Downloads/"${cmake_macos_dmg}" ]; then
        echo -ne "\n  Downloading CMake... "
        curl -sL "${cmake_macos_url}" --output "${HOME}"/Downloads/"${cmake_macos_dmg}"
        echo "ok."
      fi

      echo -e "\n************************************************************"
      echo "ERROR: Automatic installation of CMake is not supported yet."
      echo "Please manually install ${cmake_macos_dmg}."
      echo "Please open the file from your Downloads folder."
      echo -e "************************************************************\n"
      exit 1
    fi
    PATH="/Applications/CMake.app/Contents/bin${PATH:+:${PATH}}"
  fi
  echo "ok."
  ;;
MINGW*)
  echo "Windows is not supported. Please run in WSL (Windows Subsystem for Linux)." && exit 0
  ;;
*) echo "Unsupported OS: $(uname -s)" && exit 0 ;;
esac

echo -n "Checking for the Espressif IoT Development Framework... "
if [ ! -f "${esp_idf_save_directory}"/export.sh ]; then
  echo -ne "\n  Downloading the framework... "
  git -c advice.detachedHead=false clone --branch "${esp_idf_git_tag}" --single-branch --depth 1 --quiet "${esp_idf_repo_url}" "${esp_idf_temp_directory}"
  cd "${esp_idf_temp_directory}"/
  git submodule update --depth 1 --init --recursive --quiet &> /dev/null
  mv "${esp_idf_temp_directory}" "${esp_idf_save_directory}"
  echo "ok."
else
  echo
fi
cd "${esp_idf_save_directory}"
echo -ne "  Installing the framework... "
./install.sh esp32 1> /dev/null
echo -ne "ok.\n  Exporting the framework... "
# shellcheck source=/dev/null
source ./export.sh 1> /dev/null
echo "ok."

echo -n "Checking for the Blockstream Jade repository... "
if [ ! -d "${jade_save_directory}" ]; then
  echo -ne "\n  Downloading Jade... "
  git -c advice.detachedHead=false clone --branch "${jade_git_tag}" --single-branch --depth 1 --quiet "${jade_repo_url}" "${jade_save_directory}"
  cd "${jade_save_directory}"
  git submodule update --depth 1 --init --recursive --quiet &> /dev/null
fi
cd "${jade_save_directory}"
jade_version="$(git describe --tags)"
echo "ok."

if [ "${CI:-false}" = true ]; then
  cp configs/sdkconfig_display_ttgo_tdisplay.defaults sdkconfig.defaults
else
  echo -e "\nWhich device do you want to flash?"
  PS3='Please enter the number for your device or QUIT: '
  options=("${device1}" "${device2}" "${device3}" "${device4}" "QUIT")
  select chosen_device in "${options[@]}"; do
    case "${chosen_device}" in
    "${device1}")
      tty_device="/dev/ttyACM0"
      flash_command="idf.py flash"
      cp configs/sdkconfig_display_ttgo_tdisplay.defaults sdkconfig.defaults
      break
      ;;
    "${device2}")
      tty_device="/dev/ttyUSB0"
      flash_command="idf.py -b 115200 flash"
      cp configs/sdkconfig_display_m5stickcplus.defaults sdkconfig.defaults
      break
      ;;
    "${device3}")
      tty_device="/dev/ttyACM0"
      flash_command="idf.py flash"
      cp configs/sdkconfig_display_m5blackgray.defaults sdkconfig.defaults
      break
      ;;
    "${device4}")
      tty_device="/dev/ttyACM0"
      flash_command="idf.py flash"
      cp configs/sdkconfig_display_m5fire.defaults sdkconfig.defaults
      break
      ;;
    "QUIT")
      echo "You chose to quit."
      exit 0
      ;;
    *) echo "You entered ${REPLY}, which is invalid." ;;
    esac
  done
  echo
fi

[ -f sdkconfig ] && rm sdkconfig
sed -i.bak '/CONFIG_DEBUG_MODE/d' ./sdkconfig.defaults
sed -i.bak '1s/^/CONFIG_LOG_DEFAULT_LEVEL_NONE=y\n/' sdkconfig.defaults

echo -n "Building the Jade firmware... "
idf.py build &> /dev/null
echo "ok."

[ "${CI:-false}" = true ] && echo "Exiting the script for CI runners." && exit 0

case "${machine}" in
Linux*)
  while [ ! -c "${tty_device}" ]; do
    read -srn1 -p "Connect your ${chosen_device} and PRESS ANY KEY to continue... " && echo
  done
  initial_tty_device_permissions="$(stat -c '%a' "${tty_device}")"
  if [ "${initial_tty_device_permissions:2}" -lt 6 ]; then
    echo -e "\nElevating write permissions for ${chosen_device}"
    sudo chmod o+rw "${tty_device}"
    echo
  fi
  ;;
macOS*)
  echo -e "Connect your ${chosen_device} with a USB-C cable,\n  and click Allow if you see a security popup."
  read -srn1 -p "  PRESS ANY KEY to continue... " && echo && echo
  ;;
*) echo "Unsupported OS: $(uname -s)" && exit 0 ;;
esac

echo -e "Ready to install Jade ${jade_version} on your ${chosen_device}.\n  (This process can take over 10 minutes.)"
read -srn1 -p "  PRESS ANY KEY to continue... " && echo

final_confirmation_sleep_time="10"
echo -ne "\nContinuing Jade ${jade_version} installion in ${final_confirmation_sleep_time} seconds.\nPress Ctrl+C to abort ... "
sleep "${final_confirmation_sleep_time}"
echo

${flash_command}

echo -e "\nSUCCESS! Jade ${jade_version} is now installed on your ${chosen_device}.\nYou can close this window.\n"