Improved command line tools.

Signed-off-by: ubi de feo <me@ubidefeo.com>

Author: ubidefeo

shell_tools/README.md

@@ -0,0 +1,53 @@
+# MicroPython Apps Framework developer helpers [WIP]
+
+These `bash` shell scripts simplify working with the framework from the host machine and allows creating, deploying and backing up applications to and fromt he board.
+
+## Requirements
+
+These scripts require `arduino-tools-mpy` to be installed on the board and `mpremote` to be installed on the host computer:
+
+```shell
+pip install mpremote
+```
+
+## How to use
+```shell
+./chmod +x app_util
+./app_util
+mpremote: no device found
+Usage: ./app_util.sh <command>:
+• help
+• create
+• install
+• backup
+• remove
+• delete
+• list
+• run
+```
+
+## How it works
+
+These scripts will leverage the board's installed `arduino-tools-mpy` to create, backup and delete MicroPython apps on the board.
+For example, creating an app with `./app_util create {APP_NAME} {App Friendly Name}` will run code on the board, create the app (will ask for confirmation to overwrite if already present), back it up to a `.tar` archive and transfer it to the local machine, expand it and make it available locally.
+
+Running
+
+```shell
+./app_util create demo_app Demo Application
+```
+
+Will generate the following output:
+
+```shell
+☑️ Querying MicroPython board...
+☑️ Checking if "/app_weather" exists on board
+📦 App "Weather Widget" does not exist on board. Creating...
+☑️ Creating app "weather" with friendly name "Weather Widget"
+☑️ Archiving "weather" on board
+☑️ Copying app "weather" archive to local machine
+☑️ 🗜️ Extracting "weather_23987.tar" to app_weather
+
+✅ App "Weather Widget" created and available locally
+```
+

shell_tools/_backup.sh

@@ -1,5 +1,4 @@
-source _common.sh
-function backup_app {
+function transfer_app {
   app_safe_name=$(echo "$1" | tr -d '\r\n')
   output_msg="Archiving \"$app_safe_name\" on board"
   echo -n "⏳ $output_msg"
@@ -9,7 +8,6 @@ function backup_app {
   cmd+="res = export_app('$app_safe_name');print(res)"
 
   error=$(mpremote exec "$cmd")
-  # Print error message if return code is not 0
   if [ $? -ne 0 ]; then
     echo -ne "\r\033[2K"
     echo "❌ $output_msg"
@@ -25,7 +23,6 @@ function backup_app {
   echo -n "⏳ $output_msg"
 
   error=$(mpremote cp :$remote_archive_path ./)
-  # Print error message if return code is not 0
   if [ $? -ne 0 ]; then
     echo -ne "\r\033[2K"
     echo "❌ $output_msg"
@@ -37,21 +34,21 @@ function backup_app {
 
   local_folder_name="$APPS_PREFIX$app_safe_name"
   if [ -d "$local_folder_name" ]; then
-    input_msg="Delete local folder $local_folder_name?"
+    input_msg="❔ Delete local folder $local_folder_name?"
     read -p "❔ $input_msg [Y/n]: " confirm
     confirm=${confirm:-n}
 
     if [ $confirm == "Y" ]; then
       echo -ne "\033[F\r\033[2K"
-      echo "👍🏼 $input_msg"
+      echo "☑️ $input_msg"
       output_msg="Deleting local folder $local_folder_name"
       echo -n "⏳ $output_msg"
       rm -rf "$local_folder_name"
       echo -ne "\r\033[2K"
       echo "☑️ $output_msg"
     else
       echo -ne "\r\033[2K"
-      echo "👎🏼 $input_msg"
+      echo "❌ $input_msg"
       timestamp=$(date +%s)
 
       local_folder_backup_name="$local_folder_name""_backup_$timestamp"
@@ -66,7 +63,7 @@ function backup_app {
 
 
   archive_name=`basename $remote_archive_path`
-  output_msg="Extracting \"$archive_name\" to $APPS_PREFIX$app_safe_name"
+  output_msg="🗜️ Extracting \"$archive_name\" to $APPS_PREFIX$app_safe_name"
   tar --strip-components=1 -xf $archive_name
   rm -f $archive_name
   # Print error message if return code is not 0
@@ -80,16 +77,3 @@ function backup_app {
   echo "☑️ $output_msg"
 
 }
-
-
-app_safe_name=$1
-remote_app_path="$APPS_ROOT""$APPS_PREFIX""$app_safe_name"
-echo $remote_app_path
-if directory_exists $remote_app_path; then
-  echo "App \"$app_safe_name\" exists on board. Backing up locally."
-  backup_app $app_safe_name
-else
-  echo "App \"$app_safe_name\" does not exist on board. Backup canceled."
-fi
-
-echo -e "\n✅ App \"$app_safe_name\" backed up and available locally"

shell_tools/_common.sh

@@ -1,9 +1,8 @@
 #!/bin/bash
-APPS_ROOT="/"
+
 APPS_PREFIX="app_"
 ARDUINO_TOOLS_MIP_URL="github:arduino/arduino-tools-mpy"
 
-
 PYTHON_HELPERS='''
 import os
 import sys
@@ -73,6 +72,22 @@ except ImportError as e:
 
 '''
 
+function get_apps_root {
+  output_msg="Extracting board's apps root"
+  # echo -n "⏳ $output_msg" >&2
+  get_root="${PYTHON_HELPERS}print(get_root())"
+  result=$(mpremote exec "$get_root" 2>&1)
+  # Print result message if return code is not 0
+  if [ $? -ne 0 ]; then
+    echo >&2
+    echo "Error: $error" >&2
+    exit 1
+  fi
+  echo -ne "\r\033[2K" >&2
+  # echo -e "\r☑️ $output_msg: $result" >&2
+  echo "$result"
+}
+
 function check_arduino_tools {
   error=$(mpremote exec "$ARDUINO_TOOLS_CHECK")
   if [[ $error == *"Error"* ]]; then
@@ -86,26 +101,31 @@ function check_arduino_tools {
 # returns 0 if device is present, 1 if it is not
 function device_present {
   # Run mpremote and capture the error message
-  echo "⏳ Querying MicroPython board..."
+  output="Querying MicroPython board..." >&2
+  echo -ne "⏳ $output" >&2
+
   sys_info="${PYTHON_HELPERS}sys_info()"
   error=$(mpremote exec "$sys_info")
+  echo -ne "\r\033[2K" >&2
+  echo -e "\r☑️ $output" >&2
   # Return error if error message contains "OSError: [Errno 2] ENOENT"
   if [[ $error == *"no device found"* ]]; then
-      return 0
-  else
       return 1
+  else
+      return 0
   fi
 }
 
 function directory_exists {
   # Run mpremote and capture the error message
   output="Checking if \"$1\" exists on board"
-  echo -ne "❔ $output"
+  echo -ne "❔ $output" >&2
 
   error=$(mpremote fs ls $1 2>&1)
-  echo -ne "\r\033[2K"
-  echo -e "\r☑️ $output"
+  echo -ne "\r\033[2K" >&2
+  echo -e "\r☑️ $output" >&2
   # Return error if error message contains "OSError: [Errno 2] ENOENT"
+  # echo -ne "--- $error" >&2
   if [[ $error == *"OSError: [Errno 2] ENOENT"* || $error == *"No such"* ]]; then
       return 1
   else
@@ -118,15 +138,15 @@ function directory_exists {
 # Only produces output if an error occurs
 function copy_file {
   output="Copying $1 to $2"
-  echo -n "⏳ $output"
+  echo -n "⏳ $output" >&2
   # Run mpremote and capture the error message
   error=$(mpremote cp $1 $2)
   # Print error message if return code is not 0
   if [ $? -ne 0 ]; then
-    echo "Error: $error"
+    echo "Error: $error" >&2
   fi
-  echo -ne "\r\033[2K"
-  echo -e "\r☑️ $output"
+  echo -ne "\r\033[2K" >&2
+  echo -e "\r☑️ $output" >&2
 }
 
 # Deletes a file from the board using mpremote
@@ -144,25 +164,25 @@ function delete_file {
 
 function create_folder {
   output_msg="Creating $1 on board"
-  echo -n "⏳ $output_msg"
+  echo -n "⏳ $output_msg" >&2
   error=$(mpremote mkdir "$1")
   # Print error message if return code is not 0
   if [ $? -ne 0 ]; then
-    echo "Error: $error"
+    echo "Error: $error" >&2
   fi
-  echo -ne "\r\033[2K"
-  echo -e "\r☑️ $output_msg"
+  echo -ne "\r\033[2K" >&2
+  echo -e "\r☑️ $output_msg" >&2
 }
 
 function delete_folder {
   output_msg="Deleting $1 on board"
-  echo -n "⏳ $output_msg"
+  echo -n "⏳ $output_msg" >&2
   delete_folder="${PYTHON_HELPERS}delete_folder(\"/$1\")"
   error=$(mpremote exec "$delete_folder")
   # Print error message if return code is not 0
   if [ $? -ne 0 ]; then
-    echo "Error: $error"
+    echo "Error: $error" >&2
   fi
-  echo -ne "\r\033[2K"
-  echo -e "\r☑️ $output_msg"
+  echo -ne "\r\033[2K" >&2
+  echo -e "\r☑️ $output_msg" >&2
 }

shell_tools/_create.sh

@@ -1,27 +1,11 @@
-#!/bin/bash
-#
-# Create an Arduino MicroPython App on the target board.
-#
-# ./_create.sh <app_name> <friendly_name> 
-
-#########################
-# VERY WORK IN PROGRESS #
-#########################
-source _common.sh
-app_name=$1
-app_safe_name=$(echo $app_name | tr ' [:punct:]' '_')
-shift
-app_friendly_name=$*
-
-
 function create_app {
   app_safe_name=$1
   shift
-  app_friendly_name=$*
+  app_friendly_name=${*:-$app_safe_name}
 
-  if [ "$app_friendly_name" = "" ]; then
-    app_friendly_name=$app_safe_name
-  fi
+  # if [ "$app_friendly_name" = "" ]; then
+  #   app_friendly_name=$app_safe_name
+  # fi
 
   output_msg="Creating app \"$app_safe_name\" with friendly name \"$app_friendly_name\""
   echo -n "⏳ $output_msg"
@@ -46,17 +30,3 @@ function create_app {
   echo -ne "\r\033[2K"
   echo "☑️ $output_msg"
 }
-
-remote_app_path="$APPS_ROOT""$APPS_PREFIX""$app_safe_name"
-echo $remote_app_path
-if directory_exists $remote_app_path; then
-  echo "App \"$app_friendly_name\" already exists on board. Delete first."
-  exit 1
-else
-  echo "App \"$app_friendly_name\" does not exist on board. Creating..."
-  create_app $app_safe_name $app_friendly_name
-fi
-
-transfer_app $app_safe_name
-
-echo -e "\n✅ App \"$app_friendly_name\" created and available locally"