wsjtx - Initial work to add PnP support for WSJT-X 2.7.0

2026-09-17 15:41:44 -04:00 · 2026-03-22 19:34:55 -07:00
parent ba29c62e16
commit 7d778f9a36
8 changed files with 226 additions and 2 deletions
@@ -0,0 +1,138 @@
+#!/bin/bash
+#
+# Author  : Gaston Gonzalez
+# Date    : 22 March 2026
+# Purpose : Wrapper script for starting WSJT-X with PnP support
+#
+# Preconditions
+# 1. Supported radio and audio interface are connected and properly detected
+#
+# Postconditions
+# 1. Stop all running EmComm Tools modes
+# 2. WSJT-X audio settings updated
+# 3. WSJT-X started
+. /opt/emcomm-tools/bin/et-common
+
+usage() {
+  echo "usage: $(basename $0) <command>"
+  echo "  start           - Update config and start WSJT-X"
+  echo "  update-config   - Update config"
+}
+
+if [ $# -ne 1 ]; then
+  usage
+  exit 1
+fi
+
+notify_user() {
+  notify-send \
+   -t 5000 \
+   --app-name="EmComm Tools" \
+   "$1"
+}
+
+start() {
+
+  # Ensure that we have a pre-initialized CAT control connection for select radios
+  prime_rigctld_conn
+
+  /opt/emcomm-tools/bin/et-kill-all && update-config && /usr/bin/wsjtx &
+
+  if [ ! -e /dev/et-gps ]; then
+    notify-send -u critical -i \
+      /usr/share/icons/Yaru/48x48/status/dialog-information.png \
+      "No GPS. Ensure your time is accurate when WSJTX starts."
+  fi
+
+}
+
+update-config() {
+
+    WSJTX_CONF_FILE="${HOME}/.config/WSJT-X.ini"
+
+    if [[ ! -e "${WSJTX_CONF_FILE}" ]]; then
+      et-log "Creating ${WSJTX_CONF_FILE} missing. Creating from template."
+      cp /etc/skel/.config/WSJT-X.ini ${WSJTX_CONF_FILE}
+    fi
+   
+    [ -z "$ET_USER_CONFIG" ] && ET_USER_CONFIG="${HOME}/.config/emcomm-tools/user.json"
+
+    # Update configuration with current callsign and grid
+    CALLSIGN=$(cat ${ET_USER_CONFIG} | jq -r .callsign)
+    GRID=$(et-system-info grid)
+
+    if [ "${CALLSIGN}" = "N0CALL" ]; then
+      notify_user "Can't start WSJT-X. No callsign set. Run: et-user."
+      exit 1
+    fi
+
+    sed -i "s|^MyCall.*|MyCall=${CALLSIGN}|" ${WSJTX_CONF_FILE} 
+    sed -i "s|^MyGrid.*|MyGrid=${GRID}|" ${WSJTX_CONF_FILE} 
+
+    et-log "Updated WSJT-X configuration with user callsign '${CALLSIGN}' and grid: '${GRID}'"
+
+    # 1. Check if the symlink was created by the udev rules
+    if [ -e /dev/et-audio ]; then
+
+       # 2. Check that this device was properly tagged with the ET_AUDIO env variable with a udev rule
+       APLAY_OUT=$(arecord -l | grep ET_AUDIO)
+       if [ $? -eq 0 ]; then
+         AUDIO_DEVICE=$(echo $APLAY_OUT | cut -d"," -f2 | cut -d":" -f1 | awk '{print $2}')
+
+         # WSJT-X has an issue decoding the received audio following a 
+         # transmission when the device below is used. 
+         #
+         #WSJTX_AUDIO_DEVICE="plughw:CARD=ET_AUDIO,DEV=${AUDIO_DEVICE}"
+         #
+         # Instead, the following device solves this issue:
+         WSJTX_AUDIO_DEVICE="sysdefault:CARD=ET_AUDIO"
+  
+         et-log "Using '${WSJTX_AUDIO_DEVICE}' for WSJT-X configuration."
+
+         # 3. Check for existing WSJT-X sound configuration
+
+         ## Update input
+         grep "^SoundInName" ${WSJTX_CONF_FILE}
+         if [ $? -eq 0 ]; then
+           sed -i "s|^SoundInName.*|SoundInName=\"${WSJTX_AUDIO_DEVICE}\"|" ${WSJTX_CONF_FILE} 
+         else
+           echo "SoundInName=\"${WSJTX_AUDIO_DEVICE}\"" >> ${WSJTX_CONF_FILE}
+         fi
+
+         ## Update output
+         grep "^SoundOutName" ${WSJTX_CONF_FILE}
+         if [ $? -eq 0 ]; then
+           sed -i "s|^SoundOutName.*|SoundOutName=\"${WSJTX_AUDIO_DEVICE}\"|" ${WSJTX_CONF_FILE} 
+         else
+           echo "SoundOutName=\"${WSJTX_AUDIO_DEVICE}\"" >> ${WSJTX_CONF_FILE}
+         fi
+
+         ## Configure ALSA settings for sound card
+         /opt/emcomm-tools/bin/et-audio update-config
+
+       else
+         et-log "No ET_AUDIO device detected."
+         notify_user "Can't start WSJT-X. No ET_AUDIO device detected."
+         exit 1
+       fi
+    else
+      et-log "No ET_AUDIO device plugged in."
+      notify_user "Can't start WSJT-X. No supported audio device plugged in."
+      exit 1
+    fi
+
+}
+
+case $1 in
+  start)
+    start
+    ;;
+  update-config)
+    update-config
+    ;;
+  *)
+    echo "Invalid command."
+    usage
+    exit 1
+  ;;
+esac