mirror of
https://github.com/gesellix/Bose-SoundTouch.git
synced 2026-08-19 00:56:16 +00:00
Tobias GesellchenandClaude Opus 4.7
064fe80e18
Bundles the install-time hygiene work for issues #268 and #250. # Install location — #268 Stock SoundTouch rootfs has only a few MB free (~4 MB on the ST20 the reporter captured); the AfterTouch binary is ~12 MB. The previous flow downloaded into tmpfs (/media/aftertouch) and then `mv`'d the binary into /opt/aftertouch on rootfs — which fails with "No space left on device" on any speaker with the standard layout. install.sh now installs to /mnt/nv/aftertouch by default (the persistent partition, ~30 MB free on the same captures) and points /opt/aftertouch at it via a symlink so the init script's hardcoded DAEMON path keeps working unchanged. Power users can override with INSTALL_DIR=/some/other/path. The interactive prompt from the community patch in #268's thread is dropped — STDIN is the curl pipe under the documented `curl | sh` invocation, so a read prompt would hang or read garbage. uninstall.sh is updated to resolve the symlink and remove the target before unlinking, so the 12 MB binary doesn't get orphaned on /mnt/nv when users uninstall. # Logging — #250 Issue #250 surfaced a "running but unreachable" state: the install script reported AfterTouch as running, the init script's status agreed, but `curl :8000` returned connection-refused. start-stop- daemon's --background detaches stdout/stderr, so any panic the daemon emitted before dying went to /dev/null with no diagnostic trail. The fix is to route the daemon's stdout/stderr through `logger -t aftertouch` so output lands in BusyBox syslog — a bounded in-memory ring buffer that never grows on disk (writing to a file in /mnt/nv would have eaten the volume over months). Diagnostic flow is now: logread | grep aftertouch | tail -20 logread -f | grep aftertouch # live tail Matches the recipe already documented in TROUBLESHOOTING.md for the speaker's own logs (Curl 7 section). Tightening on top of the syslog change: - The init script's `status` case now also curls localhost:8000 when the PID is alive — distinguishes "PID alive, listener up" from "PID alive, listener silently died" (which is what fooled everyone on #250). A bare PID-liveness check returned "running" in both cases. - install.sh's post-install verification now does its own 10s curl probe after the init script returns; on failure it tails the aftertouch syslog so the user sees the actual error rather than the install script claiming success. - `exec` is added inside the start-stop-daemon's shell wrapper so --make-pidfile records the daemon's own PID (not the shell's), which keeps `stop` semantics correct. README updated to document the install location, INSTALL_DIR override, and the syslog tag. No automated tests — these are shell scripts the install pipeline runs once on the device. All three scripts pass `bash -n` / `sh -n` syntax checks. Real validation is end-user retest, gated on the next release. Refs #268, refs #250. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
91 lines
3.5 KiB
Bash
91 lines
3.5 KiB
Bash
#!/bin/bash
|
|
set -eo pipefail
|
|
|
|
VERSION=${VERSION:-0.79.0}
|
|
GH_REPO=${GH_REPO:-gesellix/Bose-SoundTouch}
|
|
BINARY_URL=${BINARY_URL:-https://github.com/$GH_REPO/releases/download/v$VERSION/soundtouch-service-v$VERSION-linux-armv7}
|
|
INIT_SCRIPT_URL=${INIT_SCRIPT_URL:-https://raw.githubusercontent.com/$GH_REPO/v$VERSION/scripts/on-device-install/aftertouch}
|
|
|
|
# Default install location is /mnt/nv/aftertouch (the persistent
|
|
# partition), not /opt/aftertouch on rootfs. Stock SoundTouch rootfs
|
|
# has ~4 MB free on devices like the ST20 (issue #268); the
|
|
# AfterTouch binary is ~12 MB. /mnt/nv typically has tens of MB
|
|
# free and persists across reboots the same way /opt would.
|
|
#
|
|
# /opt/aftertouch becomes a symlink into the install target so the
|
|
# init script's hardcoded DAEMON path keeps working unchanged.
|
|
#
|
|
# Power users can override with INSTALL_DIR=/some/other/path.
|
|
INSTALL_DIR=${INSTALL_DIR:-/mnt/nv/aftertouch}
|
|
|
|
# Scratch directory for the download. /media is tmpfs on most
|
|
# SoundTouch firmware, fine for transient files but unrelated to
|
|
# the persistent install target.
|
|
UPDATE_TMP_DIR=${UPDATE_TMP_DIR:-/media/aftertouch}
|
|
|
|
rm -rf "$UPDATE_TMP_DIR" || true
|
|
mkdir -p "$UPDATE_TMP_DIR"
|
|
|
|
echo "Installing AfterTouch $VERSION to $INSTALL_DIR ..."
|
|
mkdir -p "$INSTALL_DIR"
|
|
|
|
# Wire /opt/aftertouch -> $INSTALL_DIR so the init script
|
|
# (DAEMON=/opt/aftertouch/aftertouch-service) finds the binary
|
|
# regardless of which target we picked. Replace any prior
|
|
# /opt/aftertouch (directory or stale symlink) before re-creating.
|
|
if [ "$INSTALL_DIR" != "/opt/aftertouch" ]; then
|
|
rm -rf /opt/aftertouch
|
|
ln -sf "$INSTALL_DIR" /opt/aftertouch
|
|
fi
|
|
|
|
curl \
|
|
-sSL \
|
|
-o "$UPDATE_TMP_DIR/binary" \
|
|
--fail \
|
|
"$BINARY_URL"
|
|
|
|
mv "$UPDATE_TMP_DIR/binary" "$INSTALL_DIR/aftertouch-service"
|
|
chmod +x "$INSTALL_DIR/aftertouch-service"
|
|
|
|
echo "Creating init script..."
|
|
curl \
|
|
-sSL \
|
|
-o "$UPDATE_TMP_DIR/init-script" \
|
|
--fail \
|
|
"$INIT_SCRIPT_URL"
|
|
|
|
mv "$UPDATE_TMP_DIR/init-script" /etc/init.d/aftertouch
|
|
chmod +x /etc/init.d/aftertouch
|
|
update-rc.d aftertouch defaults
|
|
|
|
echo "Installation complete. Running initial startup..."
|
|
/etc/init.d/aftertouch start
|
|
|
|
/etc/init.d/aftertouch status
|
|
|
|
# Post-install verification: the init script's own poll loop only
|
|
# checks that the daemon registered a PID file; that's not enough
|
|
# evidence the listener is actually serving HTTP. Issue #250 shipped
|
|
# with a "running but unreachable" state where status was green and
|
|
# `curl :8000` got connection-refused. Re-check directly here and
|
|
# surface the recent syslog if it fails — the init script pipes the
|
|
# daemon's stdout/stderr through `logger -t aftertouch`, so panics
|
|
# land in busybox syslog and `logread` reads them out.
|
|
if curl -fsS --max-time 10 http://localhost:8000 >/dev/null 2>&1; then
|
|
echo "Installation complete. AfterTouch $VERSION is now running on your device."
|
|
echo "Connect to http://<your-device-ip>:8000 from another machine on the LAN."
|
|
echo "If the device doesn't expose :8000 directly, port-forward via SSH:"
|
|
echo " ssh -L 8000:localhost:8000 root@<IP_ADDRESS_OF_SPEAKER>"
|
|
else
|
|
echo "WARNING: the init script reports AfterTouch as running, but" >&2
|
|
echo " http://localhost:8000 isn't responding. The daemon may have" >&2
|
|
echo " panicked shortly after start. Recent aftertouch syslog:" >&2
|
|
echo "" >&2
|
|
logread 2>/dev/null | grep aftertouch | tail -20 >&2 || \
|
|
echo " (logread returned nothing for tag 'aftertouch'; the daemon" >&2
|
|
echo "" >&2
|
|
echo " For a live view of the daemon's output, run:" >&2
|
|
echo " logread -f | grep aftertouch" >&2
|
|
exit 1
|
|
fi
|