From 801422241c584fe0d937724732414c8f7d5eb4f5 Mon Sep 17 00:00:00 2001
From: DavHau <hsngrmpf+github@gmail.com>
Date: Sun, 23 Mar 2025 23:51:17 +0700
Subject: [PATCH] utils: add script ssh-deploy.sh

This script uses ssh to copy a custom HDZGOGGLE binary to the goggles and replace the running process with it.

This allows for rapid testing of changes, as one doesn't have to put the file on a sdcard each time.

example usage:
```
Usage: ./utilities/ssh-deploy.sh <host> <HDZGOGGLE_binary>
```

It stops the running HDZGOGGLE process, uploads the new binary to /tmp and launches it.

The goggle fs remains unmodified and after a reboot everything is back to normal.
---
 README.md               | 31 ++++++++++++++++++++++++++-----
 utilities/ssh-deploy.sh | 23 +++++++++++++++++++++++
 2 files changed, 49 insertions(+), 5 deletions(-)
 create mode 100755 utilities/ssh-deploy.sh

diff --git a/README.md b/README.md
index 8c685d09..b2909918 100644
--- a/README.md
+++ b/README.md
@@ -37,11 +37,14 @@ Where x.x.x is the OTA_VER.RX_VER.VA_VER
 
 ## Loading the Firmware
 
-Firmware can be either flashed via goggle menu or alternatively be executed via the SD Card with a custom development script.  An example of this development script is provided below.  The goggles automatically checks to see if the develop.sh script exists in the root of the SD Card and if found develop.sh is then executed.
+There following methods can be used to load the firmware:
+- flash it via the goggle menu
+- temporarily execute it from an sdcard
+- temporarily execute it via ssh
 
-The following files must be placed in the root of SD Card in this example. This script will then check to see if HDZGOGGLE binary has been found during bootup and if found then executed.
+### Executing firmware via sdcard
 
-Otherwise, if the HDZGOOGLE binary is not detected, the goggles will continue to load the built-in executable which was previously flashed.
+On boot, the goggles check the root of the sdcard for a `develop.sh` file. If it exists, it gets executed. This can be used to launch a custom build of the `HDZGOGGLE` executable.
 
 SD Card File Hierarchy:
 
@@ -50,9 +53,9 @@ SD Card File Hierarchy:
 /HDZGOGGLE
 ```
 
-Development script (develop.sh):
+`develop.sh` to launch HDZGOGGLE from sdcard or fall back to builtin executable if not found:
 
-```
+```bash
 #!/bin/sh
 
 # Load via SD Card if found
@@ -63,6 +66,24 @@ else
 fi
 ```
 
+### Execute firmware via ssh
+
+Use the script `./utilities/ssh-deploy.sh` inside this repo to temporarily run a custom build of the `HDZGOGGLE` executable on the goggles.
+
+Setup:
+
+1. Have the [HDZero Expansion Module](https://www.hd-zero.com/product-page/hdzero-goggle-expansion-module) installed, as this provides wifi capabilities
+2. Enable the wifi via the goggle menu and connect it to a network which is reachable from the dev machine
+3. Enter the wifi menu again on the goggle to find its IP address (for example `192.168.1.5`)
+3. Execute `./utilities/ssh-deploy.sh <host> <HDZGOGGLE_binary>`
+
+Example:
+```shellSession
+./utilities/ssh-deploy.sh root@192.168.1.5 ./build/HDZGOGGLE
+```
+
+A powercycle will switch the goggles back to the builtin `HDZGOGGLE`.
+
 ## Building the Emulator
 
 Goggle source code can be built natively on the host machine and used for debugging.
diff --git a/utilities/ssh-deploy.sh b/utilities/ssh-deploy.sh
new file mode 100755
index 00000000..e0bacbe4
--- /dev/null
+++ b/utilities/ssh-deploy.sh
@@ -0,0 +1,23 @@
+#! /usr/bin/env bash
+
+set -euo pipefail
+
+if [[ $# -ne 2 ]]; then
+  echo "Usage: $0 <host> <HDZGOGGLE_binary>"
+  exit 1
+fi
+
+host="$1"
+HDZGOGGLE_binary="$2"
+
+echo "Killing running HDZGOGGLE on $host while uploading new one to /tmp..."
+cat $HDZGOGGLE_binary | ssh $host "
+  set -x \
+  && ps | grep HDZGOGGLE | grep -v grep | awk '{print \$1}' | xargs kill || : \
+  && sleep 1 \
+  && cat > /tmp/HDZGOGGLE \
+  && chmod +wx /tmp/HDZGOGGLE
+" || :
+
+echo "starting new HDZGOGGLE..."
+ssh $host "LD_LIBRARY_PATH=/lib/eyesee-mpp:/usr/lib/eyesee-mpp /tmp/HDZGOGGLE 2>&1 >/dev/null &"