MeshTerm/scripts/picocalc/calculinux-setup.sh

#!/bin/sh
# calculinux-setup.sh -- one-time bring-up of MeshTerm on a Luckfox Lyra / PicoCalc
# running Calculinux (Yocto, systemd, read-only root with /usr + /etc + /home overlays
# backed by /data). Run as root on a freshly-flashed SD, over the serial console is fine:
#
#     sh calculinux-setup.sh
#
# It is idempotent -- safe to re-run; each phase checks before it acts. It sequences the
# whole deploy this repo's Lyra target needed, in the order the discoveries fell out:
#
#   1. opkg packages   Calculinux ships a STRIPPED python3.13 (no pip/venv/ensurepip and
#                      missing stdlib: sqlite3, ctypes, curses, shlex, xml). /usr is a
#                      writable overlay, so `opkg install python3-modules python3-pip`
#                      restores the full interpreter and persists on /data.
#   2. wi-fi kick      The USB RTL8188EU (rtl8xxxu) firmware finishes loading AFTER iwd's
#                      first scans, so on cold boot wlan0 stays UP/NO-CARRIER and the known
#                      network is never joined. A oneshot service drives RAW `iw` scans
#                      until a DHCP lease -- a completed raw scan is what lets iwd associate.
#   3. time sync       The Lyra has no battery-backed RTC, so every cold boot starts at the
#                      kernel's build-time epoch until something sets the clock -- wrong
#                      until then, which is fatal for "heard" ordering, TTL, etc. A oneshot
#                      service waits for a real route, then steps the clock once (NTP client
#                      if the image has one, else an HTTPS Date-header fallback).
#   4. timezone        `$TIMEZONE`, Eastern (America/Toronto) unless you say otherwise, via
#                      timedatectl if tzdata's opkg feed is reachable, else a POSIX TZ rule
#                      in /etc/environment -- glibc honours it with no zoneinfo database.
#                      The POSIX fallback rule is only known for the default zone; a custom
#                      $TIMEZONE without tzdata is set via timedatectl only, with a warning.
#   5. deploy user     The `$DEPLOY_USER` login MeshTerm runs under, `meshterm` unless you
#                      say otherwise (created if absent; no password is set here -- run
#                      `passwd` for it yourself).
#   6. clone           Pull MeshTerm over SSH with the read-only GitHub deploy key if one
#                      is present at $KEY_PATH, else a public HTTPS clone of $REPO_URL.
#   7. venv + install  A venv + `pip install -e .`. pip's C builds hit ENOSPC because /tmp
#                      is a tiny RAM tmpfs, so TMPDIR is redirected to $HOME/tmp on /data.
#   8. PATH            Put the venv's `meshterm` on that user's login PATH via ~/.profile.
#   9. console font    Hand off to calculinux-console-font-6x12.sh (braille + node glyphs +
#                      rounded frame corners + the list cursor the bare console can't draw).
#
# Two prerequisites this script cannot safely embed and will check for / guide you through:
#   * the read-only deploy key at $KEY_PATH, if you want the SSH clone (never commit a
#     private key) -- omit it and the clone falls back to public HTTPS;
#   * Wi-Fi credentials known to iwd. The kick only nudges an ALREADY-known network. Either
#     provision it once by hand (`iwctl station wlan0 connect <SSID>`), or export
#     WIFI_SSID and WIFI_PSK before running and this script writes the iwd config for you.
set -eu

# --- knobs (override via the environment) ----------------------------------------------
DEPLOY_USER="${DEPLOY_USER:-meshterm}"
TIMEZONE="${TIMEZONE:-America/Toronto}"
REPO_SSH="${REPO_SSH:-git@github.com:jpmartineau/MeshTerm.git}"
REPO_URL="${REPO_URL:-https://github.com/jpmartineau/MeshTerm.git}"  # used when no deploy key is present
KEY_PATH="${KEY_PATH:-/home/$DEPLOY_USER/.ssh/id_ed25519}"
CHECKOUT="/home/$DEPLOY_USER/MeshTerm"
WIFI_SSID="${WIFI_SSID:-}"     # optional: set both to have iwd credentials written
WIFI_PSK="${WIFI_PSK:-}"

SCRIPT_DIR=$(CDPATH= cd -- "$(dirname -- "$0")" && pwd)

log()  { printf '\n== %s\n' "$*"; }
info() { printf '   %s\n' "$*"; }
die()  { printf 'error: %s\n' "$*" >&2; exit 1; }
have() { command -v "$1" >/dev/null 2>&1; }
runas() { su - "$DEPLOY_USER" -c "$1"; }

[ "$(id -u)" = 0 ] || die "run as root (installs packages, writes /etc, creates the user)"

# --- 1. opkg packages ------------------------------------------------------------------
log "1/9  system packages (opkg)"
if have opkg; then
    opkg update >/dev/null 2>&1 || info "opkg update failed (no network yet?) -- continuing"
    # git and kbd ship in the base image; the python pieces are what the stripped build drops.
    for pkg in python3-modules python3-pip git kbd; do
        if opkg status "$pkg" 2>/dev/null | grep -q '^Status:.*installed'; then
            info "$pkg already installed"
        else
            info "installing $pkg"
            opkg install "$pkg" || die "opkg install $pkg failed (need network for the feed)"
        fi
    done
else
    info "opkg not found -- assuming packages are already present"
fi
have python3 || die "python3 still missing after opkg (check the opkg feed / network)"

# --- 2. wi-fi boot-scan kick (rtl8xxxu race workaround) --------------------------------
log "2/9  wi-fi boot-scan kick"

# Optionally provision the iwd network so the kick has something known to join. Secrets
# come from the environment only -- nothing is written to disk from this repo.
if [ -n "$WIFI_SSID" ] && [ -n "$WIFI_PSK" ]; then
    info "writing iwd credentials for '$WIFI_SSID'"
    mkdir -p /var/lib/iwd
    printf '[Security]\nPassphrase=%s\n' "$WIFI_PSK" > "/var/lib/iwd/$WIFI_SSID.psk"
    chmod 600 "/var/lib/iwd/$WIFI_SSID.psk"
elif [ -n "$WIFI_SSID" ] || [ -n "$WIFI_PSK" ]; then
    info "WIFI_SSID and WIFI_PSK must BOTH be set to write credentials -- skipping"
else
    info "no WIFI_SSID/WIFI_PSK given -- the kick will nudge whatever iwd already knows"
fi

cat > /etc/wifi-kick.sh <<'KICKEOF'
#!/bin/sh
# rtl8xxxu boot workaround.
#
# On cold boot iwd comes up before the RTL8188EU firmware finishes loading and
# its own scans then return nothing, so wlan0 stays UP/NO-CARRIER and the known
# network (stored PSK) is never joined. A *raw* "iw dev wlan0 scan" does work,
# and a completed raw scan populates the mac80211 results, after which iwd
# immediately authenticates/associates to the known network on its own.
#
# So we just drive raw scans until we get a DHCP lease. Do NOT use
# "iwctl scan" here: it makes iwd grab the device and the raw scan then fails
# busy (that is why a scan-only nudge did not work).

has_ip() {
    ip -4 addr show wlan0 2>/dev/null | grep -q "inet "
}

# Wait for the dongle to enumerate.
n=0
while [ $n -lt 60 ]; do
    [ -d /sys/class/net/wlan0 ] && break
    sleep 1
    n=$((n + 1))
done

# Drive raw scans until iwd associates and DHCP lands (~5 min ceiling).
i=0
while [ $i -lt 30 ]; do
    has_ip && exit 0
    /usr/sbin/ip link set wlan0 up 2>/dev/null
    /usr/sbin/iw dev wlan0 scan >/dev/null 2>&1
    # Association + DHCP follow a completed scan; poll before scanning again.
    j=0
    while [ $j -lt 5 ]; do
        sleep 2
        has_ip && exit 0
        j=$((j + 1))
    done
    i=$((i + 1))
done
exit 0
KICKEOF
chmod +x /etc/wifi-kick.sh

cat > /etc/systemd/system/wifi-kick.service <<'UNITEOF'
[Unit]
Description=Nudge iwd to reconnect wlan0 at boot (rtl8xxxu workaround)
After=iwd.service
Wants=iwd.service

[Service]
Type=oneshot
RemainAfterExit=yes
ExecStart=/etc/wifi-kick.sh

[Install]
WantedBy=multi-user.target
UNITEOF

systemctl daemon-reload
systemctl enable wifi-kick.service >/dev/null 2>&1 || info "could not enable wifi-kick.service"
info "installed /etc/wifi-kick.sh + wifi-kick.service (enabled)"

# --- 3. time sync at boot (no battery-backed RTC on this board) ------------------------
log "3/9  time sync at boot"

cat > /etc/time-sync.sh <<'TIMEEOF'
#!/bin/sh
# No RTC workaround.
#
# The Lyra has no battery-backed RTC, so every cold boot starts the clock at
# the kernel's build-time epoch and stays there until something sets it. That
# is wrong for anything timestamped early -- heard-node ages, TTL, the SQLite
# observation log -- so this runs once at boot, after a real route exists, and
# steps the clock via whichever NTP client the image ships. If none is present
# it falls back to an HTTPS response's Date header (accurate to ~1s, which is
# plenty here). hwclock -w is best-effort: if there truly is no RTC it just
# fails harmlessly and next boot repeats this.

has_route() {
    ip route get 1.1.1.1 >/dev/null 2>&1
}

# Wait for a default route (~5 min ceiling). wifi-kick.service already nudges
# wlan0 up before this unit starts; this loop covers ethernet too.
n=0
while [ $n -lt 150 ]; do
    has_route && break
    sleep 2
    n=$((n + 1))
done
has_route || exit 0

synced=1
if command -v chronyd >/dev/null 2>&1; then
    chronyd -q 'server pool.ntp.org iburst' >/dev/null 2>&1 && synced=0
elif command -v ntpd >/dev/null 2>&1; then
    ntpd -n -q -p pool.ntp.org >/dev/null 2>&1 && synced=0
elif command -v sntp >/dev/null 2>&1; then
    sntp -sS pool.ntp.org >/dev/null 2>&1 && synced=0
fi

if [ "$synced" -ne 0 ]; then
    for url in https://www.cloudflare.com https://www.google.com; do
        http_date=$(curl -fsSI --max-time 10 "$url" 2>/dev/null | grep -i '^date:' | cut -d' ' -f2- | tr -d '\r')
        [ -n "$http_date" ] && date -s "$http_date" >/dev/null 2>&1 && { synced=0; break; }
    done
fi

[ "$synced" -eq 0 ] && hwclock -w >/dev/null 2>&1
exit 0
TIMEEOF
chmod +x /etc/time-sync.sh

cat > /etc/systemd/system/time-sync.service <<'UNITEOF'
[Unit]
Description=Step the system clock once the network is up (no RTC on this board)
After=network.target wifi-kick.service
Wants=wifi-kick.service

[Service]
Type=oneshot
RemainAfterExit=yes
ExecStart=/etc/time-sync.sh

[Install]
WantedBy=multi-user.target
UNITEOF

systemctl daemon-reload
systemctl enable time-sync.service >/dev/null 2>&1 || info "could not enable time-sync.service"
info "installed /etc/time-sync.sh + time-sync.service (enabled)"

# --- 4. timezone ($TIMEZONE -- America/Toronto/Eastern by default) ---------------------
log "4/9  timezone ($TIMEZONE)"
opkg install tzdata-americas tzdata-core >/dev/null 2>&1 || true
if [ -f "/usr/share/zoneinfo/$TIMEZONE" ]; then
    if [ "$(timedatectl show -p Timezone --value 2>/dev/null)" != "$TIMEZONE" ]; then
        timedatectl set-timezone "$TIMEZONE" && info "set via timedatectl (tzdata present)"
    else
        info "already $TIMEZONE (timedatectl)"
    fi
elif [ "$TIMEZONE" = "America/Toronto" ] || [ "$TIMEZONE" = "America/Montreal" ]; then
    # opkg.calculinux.org's feed has been observed fully empty (404 at the index, not just
    # this package) -- no zoneinfo database reaches the device then. glibc still honours a
    # POSIX TZ rule without one, so fall back to the exact US/Canada Eastern DST rule
    # (2nd Sun Mar -> 1st Sun Nov) America/Toronto and America/Montreal have shared since 2007.
    TZ_POSIX='EST5EDT,M3.2.0,M11.1.0/2'
    if grep -q "^TZ=$TZ_POSIX\$" /etc/environment 2>/dev/null; then
        info "already set (TZ=$TZ_POSIX in /etc/environment, no tzdata)"
    else
        sed -i '/^TZ=/d' /etc/environment 2>/dev/null || true
        printf 'TZ=%s\n' "$TZ_POSIX" >> /etc/environment
        info "no tzdata (feed empty or offline) -- set TZ=$TZ_POSIX in /etc/environment"
    fi
    if runas "grep -q '^export TZ=' ~/.profile 2>/dev/null"; then
        info "$DEPLOY_USER's ~/.profile already exports TZ"
    else
        runas "printf '\n# Eastern time (America/Toronto == America/Montreal); POSIX rule -- no tzdata feed\nexport TZ=$TZ_POSIX\n' >> ~/.profile"
        info "added TZ export to $DEPLOY_USER's ~/.profile (belt-and-suspenders for non-PAM logins)"
    fi
else
    # No POSIX DST rule is known here for a non-default $TIMEZONE without a tzdata feed;
    # set it via timedatectl if it takes, otherwise warn and move on rather than guess.
    if timedatectl set-timezone "$TIMEZONE" 2>/dev/null; then
        info "set via timedatectl"
    else
        info "warning: no tzdata for $TIMEZONE and no POSIX fallback rule known -- clock stays UTC"
    fi
fi

# --- 5. deploy user --------------------------------------------------------------------
log "5/9  deploy user '$DEPLOY_USER'"
if id "$DEPLOY_USER" >/dev/null 2>&1; then
    info "user exists"
else
    info "creating user"
    if have useradd; then
        useradd -m -s /bin/bash "$DEPLOY_USER" || die "useradd failed"
    else
        adduser -D -s /bin/bash "$DEPLOY_USER" || die "adduser failed"
    fi
    # wheel -> sudo; harmless if the group is absent.
    (usermod -aG wheel "$DEPLOY_USER" 2>/dev/null || adduser "$DEPLOY_USER" wheel 2>/dev/null) || true
    info "no password set -- run:  passwd $DEPLOY_USER"
fi
# input -> the F-key lane's Shift watcher reads /dev/input (services/modifier_watch);
# dialout/video are needed for serial radios and the framebuffer. All idempotent.
for grp in input dialout video; do
    (usermod -aG "$grp" "$DEPLOY_USER" 2>/dev/null || adduser "$DEPLOY_USER" "$grp" 2>/dev/null) || true
done

# --- 5. clone MeshTerm (SSH deploy key if present at $KEY_PATH, else public HTTPS) -----
log "6/9  clone MeshTerm"
if [ -f "$KEY_PATH" ]; then
    CLONE_URL="$REPO_SSH"
    KNOWN_HOSTS="/home/$DEPLOY_USER/.ssh/known_hosts"
    SSH_CMD="ssh -i $KEY_PATH -o IdentitiesOnly=yes -o UserKnownHostsFile=$KNOWN_HOSTS"
    # Pin github.com's host key up front so the clone never blocks on an interactive prompt.
    if ! runas "test -f $KNOWN_HOSTS && grep -q github.com $KNOWN_HOSTS"; then
        info "recording github.com host key"
        runas "ssh-keyscan -t ed25519 github.com >> $KNOWN_HOSTS 2>/dev/null" || info "ssh-keyscan failed (offline?)"
    fi
    CLONE_ENV="GIT_SSH_COMMAND='$SSH_CMD' "
else
    info "no deploy key at $KEY_PATH -- cloning $REPO_URL over public HTTPS instead"
    CLONE_URL="$REPO_URL"
    CLONE_ENV=""
fi

if [ -d "$CHECKOUT/.git" ]; then
    info "already cloned -- pulling"
    runas "git -C ~/MeshTerm pull --ff-only" || info "pull failed (offline?) -- continuing"
else
    info "cloning $CLONE_URL"
    runas "${CLONE_ENV}git clone $CLONE_URL ~/MeshTerm" \
        || die "clone failed (key not authorized, or offline)"
    if [ -f "$KEY_PATH" ]; then
        # Bake the deploy key into the checkout so later pulls just work.
        runas "git -C ~/MeshTerm config core.sshCommand '$SSH_CMD'"
    fi
fi

# --- 6. venv + editable install (TMPDIR off the RAM tmpfs) -----------------------------
log "7/9  python venv + install"
if runas "test -x ~/MeshTerm/.venv/bin/python"; then
    info "venv exists"
else
    info "creating venv"
    runas "python3 -m venv ~/MeshTerm/.venv" || die "venv creation failed"
fi
info "pip install -e . (TMPDIR on /data to dodge the /tmp ENOSPC)"
runas "mkdir -p ~/tmp && cd ~/MeshTerm && TMPDIR=\$HOME/tmp .venv/bin/pip install -e ." \
    || die "pip install failed"

# --- 7. PATH (login shells) ------------------------------------------------------------
log "8/9  login PATH"
PROFILE="/home/$DEPLOY_USER/.profile"
if [ -f "$PROFILE" ] && grep -q 'MeshTerm/.venv/bin' "$PROFILE"; then
    info "already on PATH"
else
    info "adding venv to PATH in ~/.profile"
    printf '\n# MeshTerm venv on PATH\nexport PATH="$HOME/MeshTerm/.venv/bin:$PATH"\n' >> "$PROFILE"
    chown "$DEPLOY_USER:$DEPLOY_USER" "$PROFILE"
fi

# --- 8. console font -------------------------------------------------------------------
log "9/9  console font"
if [ -f "$SCRIPT_DIR/calculinux-console-font-6x12.sh" ]; then
    sh "$SCRIPT_DIR/calculinux-console-font-6x12.sh"
else
    info "calculinux-console-font-6x12.sh not alongside this script -- skipping (run it separately)"
fi

# --- done ------------------------------------------------------------------------------
log "done"
info "log in as $DEPLOY_USER and run 'meshterm' (live) or 'meshterm --mock' (simulator)."
[ -n "$WIFI_SSID" ] || info "if wi-fi never comes up on boot, provision it once: iwctl station wlan0 connect <SSID>"