#!/bin/bash #================================================================ # HEADER #================================================================ #% SYNOPSIS #+ ${SCRIPT_NAME} [-hv] #% #% DESCRIPTION #% This script provides a GUI to configure and start/stop #% Direwolf and pat. It is designed to work on the Hampi image. #% #% OPTIONS #% -h, --help Print this help #% -v, --version Print script information #% #================================================================ #- IMPLEMENTATION #- version ${SCRIPT_NAME} 1.3.7 #- author Steve Magnuson, AG7GN #- license CC-BY-SA Creative Commons License #- script_id 0 #- #================================================================ # HISTORY # 20200428 : Steve Magnuson : Script creation. # 20200507 : Steve Magnuson : Bug fixes # #================================================================ # DEBUG OPTION # set -n # Uncomment to check your syntax, without execution. # set -x # Uncomment to debug this shell script # #================================================================ # END_OF_HEADER #================================================================ SYNTAX=false DEBUG=false Optnum=$# #============================ # FUNCTIONS #============================ function TrapCleanup() { [[ -d "${TMPDIR}" ]] && rm -rf "${TMPDIR}/" pkill "^(pat|direwolf)" for P in ${YAD_PIDs[@]} do kill $P >/dev/null 2>&1 done kill $RIG_PID >/dev/null 2>&1 sudo pkill kissattach >/dev/null 2>&1 rm -f /tmp/kisstnc rm -f $PIPE } function SafeExit() { TrapCleanup trap - INT TERM EXIT exit 0 } function ScriptInfo() { HEAD_FILTER="^#-" [[ "$1" = "usage" ]] && HEAD_FILTER="^#+" [[ "$1" = "full" ]] && HEAD_FILTER="^#[%+]" [[ "$1" = "version" ]] && HEAD_FILTER="^#-" head -${SCRIPT_HEADSIZE:-99} ${0} | grep -e "${HEAD_FILTER}" | \ sed -e "s/${HEAD_FILTER}//g" \ -e "s/\${SCRIPT_NAME}/${SCRIPT_NAME}/g" \ -e "s/\${SPEED}/${SPEED}/g" \ -e "s/\${DEFAULT_PORTSTRING}/${DEFAULT_PORTSTRING}/g" } function Usage() { printf "Usage: " ScriptInfo usage exit } function Die () { echo "${*}" SafeExit } function loadSettings () { MODEMs="1200!9600" ARATEs="48000!96000" PTTs="GPIO 12!GPIO 23" DW_CONFIG="$TMPDIR/direwolf.conf" if [ -s "$CONFIG_FILE" ] then # There is a config file echo "$CONFIG_FILE found." >&3 source "$CONFIG_FILE" else # Set some default values in a new config file echo "Config file $CONFIG_FILE not found. Creating a new one with default values." >&3 echo "declare -gA F" > "$CONFIG_FILE" echo "F[_CALL_]='N0CALL'" >> "$CONFIG_FILE" echo "F[_MODEM_]='1200'" >> "$CONFIG_FILE" echo "F[_ADEVICE_CAPTURE_]='null'" >> "$CONFIG_FILE" echo "F[_ADEVICE_PLAY_]='null'" >> "$CONFIG_FILE" echo "F[_ARATE_]='96000'" >> "$CONFIG_FILE" echo "F[_PTT_]='GPIO 23'" >> "$CONFIG_FILE" echo "F[_TXDELAY_]='200'" >> "$CONFIG_FILE" echo "F[_TXTAIL_]='50'" >> "$CONFIG_FILE" echo "F[_PERSIST_]='64'" >> "$CONFIG_FILE" echo "F[_SLOTTIME_]='20'" >> "$CONFIG_FILE" echo "F[_AUDIOSTATS_]='60'" >> "$CONFIG_FILE" echo "F[_AGWPORT_]='8001'" >> "$CONFIG_FILE" echo "F[_KISSPORT_]='8010'" >> "$CONFIG_FILE" echo "F[_PAT_HTTP_]='FALSE'" >> "$CONFIG_FILE" source "$CONFIG_FILE" fi MYCALL="${F[_CALL_]}" [[ $MODEMs =~ ${F[_MODEM_]} ]] && MODEMs="$(echo "$MODEMs" | sed "s/${F[_MODEM_]}/\^${F[_MODEM_]}/")" if pgrep pulseaudio >/dev/null 2>&1 then # There may be pulseaudio ALSA devices. Look for them. CAPTURE_IGNORE="$(pacmd list-sinks 2>/dev/null | grep name: | tr -d '\t' | cut -d' ' -f2 | sed 's/^$//' | tr '\n' '\|' | sed 's/|/\\|/g')" ADEVICE_CAPTUREs="$(arecord -L | grep -v "$CAPTURE_IGNORE^ .*\|^dsnoop\|^sys\|^default\|^dmix\|^hw\|^usbstream\|^jack\|^pulse" | tr '\n' '!' | sed 's/!$//')" PLAYBACK_IGNORE="$(pacmd list-sources 2>/dev/null | grep name: | tr -d '\t' | cut -d' ' -f2 | sed 's/^$//' | tr '\n' '\|' | sed 's/|/\\|/g')" ADEVICE_PLAYBACKs="$(aplay -L | grep -v "$PLAYBACK_IGNORE^ .*\|^dsnoop\|^sys\|^default\|^dmix\|^hw\|^usbstream\|^jack\|^pulse" | tr '\n' '!' | sed 's/!$//')" else # pulseaudio isn't running. Check only for null and plughw devices ADEVICE_CAPTUREs="$(arecord -L | grep "^null\|^plughw" | tr '\n' '!' | sed 's/!$//')" ADEVICE_PLAYBACKs="$(aplay -L | grep "^null\|^plughw" | tr '\n' '!' | sed 's/!$//')" fi [[ $ADEVICE_CAPTUREs =~ ${F[_ADEVICE_CAPTURE_]} ]] && ADEVICE_CAPTUREs="$(echo "$ADEVICE_CAPTUREs" | sed "s/${F[_ADEVICE_CAPTURE_]}/\^${F[_ADEVICE_CAPTURE_]}/")" [[ $ADEVICE_CAPTUREs == "" ]] && ADEVICE_CAPTUREs="null" [[ $ADEVICE_PLAYBACKs =~ ${F[_ADEVICE_PLAY_]} ]] && ADEVICE_PLAYBACKs="$(echo "$ADEVICE_PLAYBACKs" | sed "s/${F[_ADEVICE_PLAY_]}/\^${F[_ADEVICE_PLAY_]}/")" [[ $ADEVICE_PLAYBACKs == "" ]] && ADEVICE_PLAYBACKs="null" [[ $ARATEs =~ ${F[_ARATE_]} ]] && ARATEs="$(echo "$ARATEs" | sed "s/${F[_ARATE_]}/\^${F[_ARATE_]}/")" if [[ $PTTs =~ ${F[_PTT_]} ]] then PTTs="$(echo "$PTTs" | sed "s/${F[_PTT_]}/\^${F[_PTT_]}/")" else PTTs+="!^${F[_PTT_]}" fi TXDELAY="${F[_TXDELAY_]}" TXTAIL="${F[_TXTAIL_]}" PERSIST="${F[_PERSIST_]}" SLOTTIME="${F[_SLOTTIME_]}" AUDIOSTATs="0!15!30!45!60!90!120" [[ $AUDIOSTATs =~ ${F[_AUDIOSTATS_]} ]] && AUDIOSTATs="$(echo "$AUDIOSTATs" | sed "s/${F[_AUDIOSTATS_]}/\^${F[_AUDIOSTATS_]}/")" AGWPORT="${F[_AGWPORT_]}" KISSPORT="${F[_KISSPORT_]}" # Create a Direwolf config file with these settings cat > $DW_CONFIG </dev/null 2>&1 && [ -s $PAT_CONFIG ] then PAT_START_HTTP="${F[_PAT_HTTP_]}" PAT_CALL="$(jq -r ".mycall" $PAT_CONFIG)" PAT_PASSWORD="$(jq -r ".secure_login_password" $PAT_CONFIG)" PAT_HTTP_PORT="$(jq -r ".http_addr" $PAT_CONFIG | cut -d: -f2)" PAT_TELNET_PORT="$(jq -r ".telnet.listen_addr" $PAT_CONFIG | cut -d: -f2)" PAT_LOCATOR="$(jq -r ".locator" $PAT_CONFIG)" fi } #============================ # FILES AND VARIABLES #============================ # Set Temp Directory # ----------------------------------- # Create temp directory with three random numbers and the process ID # in the name. This directory is removed automatically at exit. # ----------------------------------- TMPDIR="/tmp/${SCRIPT_NAME}.$RANDOM.$RANDOM.$RANDOM.$$" (umask 077 && mkdir "${TMPDIR}") || { Die "Could not create temporary directory! Exiting." } #== general variables ==# SCRIPT_NAME="$(basename ${0})" # scriptname without path SCRIPT_DIR="$( cd $(dirname "$0") && pwd )" # script directory SCRIPT_FULLPATH="${SCRIPT_DIR}/${SCRIPT_NAME}" SCRIPT_ID="$(ScriptInfo | grep script_id | tr -s ' ' | cut -d' ' -f3)" SCRIPT_HEADSIZE=$(grep -sn "^# END_OF_HEADER" ${0} | head -1 | cut -f1 -d:) VERSION="$(ScriptInfo version | grep version | tr -s ' ' | cut -d' ' -f 4)" TITLE="Direwolf TNC Monitor and Configuration $VERSION" CONFIG_FILE="$HOME/direwolf_tnc.conf" MESSAGE="Direwolf Configuration" ID="${RANDOM}" AX25PORT="wl2k" AX25PORTFILE="/etc/ax25/axports" PAT_CONFIG="$HOME/.wl2k/config.json" RETURN_CODE=0 DIREWOLF="$(command -v direwolf) -p -t 0 -d u" #PAT="$(command -v pat) --log /dev/stdout -l ax25,telnet http" PAT="$(command -v pat) -l ax25,telnet http" PIPE=$TMPDIR/pipe mkfifo $PIPE exec 3<> $PIPE #============================ # PARSE OPTIONS WITH GETOPTS #============================ #== set short options ==# SCRIPT_OPTS=':hv-:' #== set long options associated with short one ==# typeset -A ARRAY_OPTS ARRAY_OPTS=( [help]=h [version]=v ) LONG_OPTS="^($(echo "${!ARRAY_OPTS[@]}" | tr ' ' '|'))=" # Parse options while getopts ${SCRIPT_OPTS} OPTION do # Translate long options to short if [[ "x$OPTION" == "x-" ]] then LONG_OPTION=$OPTARG LONG_OPTARG=$(echo $LONG_OPTION | egrep "$LONG_OPTS" | cut -d'=' -f2-) LONG_OPTIND=-1 [[ "x$LONG_OPTARG" = "x" ]] && LONG_OPTIND=$OPTIND || LONG_OPTION=$(echo $OPTARG | cut -d'=' -f1) [[ $LONG_OPTIND -ne -1 ]] && eval LONG_OPTARG="\$$LONG_OPTIND" OPTION=${ARRAY_OPTS[$LONG_OPTION]} [[ "x$OPTION" = "x" ]] && OPTION="?" OPTARG="-$LONG_OPTION" if [[ $( echo "${SCRIPT_OPTS}" | grep -c "${OPTION}:" ) -eq 1 ]]; then if [[ "x${LONG_OPTARG}" = "x" ]] || [[ "${LONG_OPTARG}" = -* ]]; then OPTION=":" OPTARG="-$LONG_OPTION" else OPTARG="$LONG_OPTARG"; if [[ $LONG_OPTIND -ne -1 ]]; then [[ $OPTIND -le $Optnum ]] && OPTIND=$(( $OPTIND+1 )) shift $OPTIND OPTIND=1 fi fi fi fi # Options followed by another option instead of argument if [[ "x${OPTION}" != "x:" ]] && [[ "x${OPTION}" != "x?" ]] && [[ "${OPTARG}" = -* ]]; then OPTARG="$OPTION" OPTION=":" fi # Finally, manage options case "$OPTION" in h) ScriptInfo full exit 0 ;; v) ScriptInfo version exit 0 ;; :) Die "${SCRIPT_NAME}: -$OPTARG: option requires an argument" ;; ?) Die "${SCRIPT_NAME}: -$OPTARG: unknown option" ;; esac done shift $((${OPTIND} - 1)) ## shift options # Check for required apps. for A in yad pat jq sponge rigctld do command -v $A >/dev/null 2>&1 || Die "$A is required but not installed." done # Ensure only one instance of this script is running. pidof -o %PPID -x $(basename "$0") >/dev/null && exit 1 #============================ # MAIN SCRIPT #============================ # Trap bad exits with cleanup function trap SafeExit EXIT INT TERM # Exit on error. Append '||true' when you run the script if you expect an error. set -o errexit # Check Syntax if set $SYNTAX && set -n # Run in debug mode, if set $DEBUG && set -x # Configure /etc/ax25/axports if necessary. This is needed in order to allocate a PTY for pat. if ! grep -q "^$AX25PORT[[:space:]]" $AX25PORTFILE 2>/dev/null then echo "$AX25PORT $MYCALL 0 255 7 Winlink" | sudo tee --append $AX25PORTFILE >/dev/null fi # Set up a dummy rig for rigctl in pat RIG="$(jq -r .hamlib_rigs $PAT_CONFIG)" if [[ $RIG == "{}" ]] then # No rigs configured. Make a dummy rig cat $PAT_CONFIG | jq \ '.hamlib_rigs += {"dummy": {"address": "localhost:4532", "network": "tcp"}}' | sponge $PAT_CONFIG # Add the dummy rig to the ax25 section cat $PAT_CONFIG | jq \ --arg R "dummy" \ '.ax25.rig = $R' | sponge $PAT_CONFIG fi while [[ $RETURN_CODE == 0 ]] do YAD_PIDs=() # Kill any running processes and load latest settings pgrep "^(pat|direwolf)" >/dev/null && pkill "^(pat|direwolf)" for P in ${YAD_PIDs[@]} do ps x | egrep -q "^$P" && kill $P done sudo pgrep kissattach >/dev/null && sudo pkill kissattach rm -f $TMPDIR/CONFIGURE_TNC.txt $TMPDIR/CONFIGURE_PAT.txt rm -f /tmp/kisstnc loadSettings # Start the tail window tab TEXT="AGW Port: $AGWPORT KISS Port: $KISSPORT" [[ $PAT_START_HTTP == TRUE ]] && TEXT+=" pat Telnet Port: $PAT_TELNET_PORT pat Web Server: http://$HOSTNAME.local:$PAT_HTTP_PORT" yad --plug="$ID" --tabnum=1 \ --back=black --fore=yellow --selectable-labels \ --text-info --text-align=center --text="$TEXT" \ --editable --tail --center <&3 & YAD_PIDs+=( $! ) # Start rigctld. Assume should use the dummy rig. if ! pgrep rigctld >/dev/null then echo "Starting rigctld using dummy rig..." >&3 $(command -v rigctld) -m 1 >&3 2>&3 & RIG_PID=$! echo "Done." >&3 fi # Start Direwolf [[ ${F[_AUDIOSTATS_]} == 0 ]] || DIREWOLF+=" -a ${F[_AUDIOSTATS_]}" $DIREWOLF -c $DW_CONFIG >&3 2>&3 & # Wait for Direwolf to allocate a PTY COUNTER=0 MAXWAIT=8 while [ $COUNTER -lt $MAXWAIT ] do # Allocate a PTY to ax25 [ -L /tmp/kisstnc ] && break sleep 1 let COUNTER=COUNTER+1 done if [ $COUNTER -ge $MAXWAIT ] then Die "Direwolf failed to allocate a PTY! Aborting. Is ADEVICE set to your sound card?" fi echo "Direwolf started." >&3 # Start kissattach on new PTY sudo $(command -v kissattach) $(readlink -f /tmp/kisstnc) $AX25PORT >&3 2>&1 [ $? -eq 0 ] || Die "kissattach failed. Aborting." KISSPARMS="-c 1 -p $AX25PORT -t $TXDELAY -l $TXTAIL -s $SLOTTIME -r $PERSIST -f n" echo "Setting $(command -v kissparms) $KISSPARMS" >&3 sleep 2 sudo $(command -v kissparms) $KISSPARMS >&3 2>&3 [ $? -eq 0 ] || Die "kissparms settings failed. Aborting." # Start pat [[ $PAT_START_HTTP == TRUE ]] && $PAT >&3 2>&3 & # Set up second tab, for configuring Direwolf. yad --plug="$ID" --tabnum=2 \ --text="Direwolf TNC Configuration\n\n \ Typical Direwolf Sound Card and PTT Settings\n \ LEFT Radio: Use ADEVICEs \ fepi-capture-left and fepi-playback-left and PTT GPIO 12.\n \ RIGHT Radio: Use ADEVICEs \ fepi-capture-right and fepi-playback-right and PTT GPIO 23.\n\n \ Click the Restart... button below after you make your changes.\n\n" \ --item-separator="!" \ --separator="|" \ --align=right \ --text-align=center \ --align=right \ --borders=20 \ --form \ --columns=2 \ --field="Call Sign" "$MYCALL" \ --field="Direwolf Capture ADEVICE":CB "$ADEVICE_CAPTUREs" \ --field="Direwolf Playback ADEVICE":CB "$ADEVICE_PLAYBACKs" \ --field="Direwolf ARATE":CB "$ARATEs" \ --field="Direwolf MODEM":CB "$MODEMs" \ --field="Direwolf PTT":CBE "$PTTs" \ --field="Audio Stats interval (s)":CB "$AUDIOSTATs" \ --field="AGW Port":NUM "$AGWPORT!8001..8010!1!" \ --field="KISS Port":NUM "$KISSPORT!8011..8020!1!" \ --focus-field 1 > $TMPDIR/CONFIGURE_TNC.txt & YAD_PIDs+=( $! ) # If pat is installed, set up a 3rd tab for it's configuration PAT_TAB="" if command -v pat >/dev/null && [ -s $PAT_CONFIG ] then # pat is installed, so add a configuration dialog for it. yad --plug="$ID" --tabnum=3 \ --text="pat Configuration\n\n \ Click the Restart... button below after you make your changes.\n\n" \ --item-separator="!" \ --separator="|" \ --align=right \ --text-align=center \ --align=right \ --borders=20 \ --form \ --columns=2 \ --field="Call Sign" "$PAT_CALL" \ --field="Winlink Password":H "$PAT_PASSWORD" \ --field="Locator Code" "$PAT_LOCATOR" \ --field="Web Service Port":NUM "$PAT_HTTP_PORT!8040..8049!1!" \ --field="Telnet Service Port":NUM "$PAT_TELNET_PORT!8770..8779!1!" \ --field="Start pat web service when Direwolf TNC starts":CHK "$PAT_START_HTTP" \ --field="TX Delay (ms)":NUM "$TXDELAY!0..500!1!" \ --field="TX Tail (ms)":NUM "$TXTAIL!0..200!10!" \ --field="Persist":NUM "$PERSIST!0..255!1!" \ --field="Slot Time (ms)":NUM "$SLOTTIME!0..255!10!" \ --field="Edit pat Connection Aliases":FBTN "bash -c edit_pat_aliases.sh &" \ --focus-field 1 > $TMPDIR/CONFIGURE_PAT.txt & YAD_PIDs+=( $! ) STOP_BUTTON_TEXT="TNC" RESTART_BUTTON_TEXT="Restart Direwolf TNC" [[ $PAT_START_HTTP == TRUE ]] && AND_PAT=" and pat" || AND_PAT="" else # pat is not installed. Print a message to that effect. yad --plug="$ID" --tabnum=3 \ --info --text-align=center \ --text="pat is not installed.\nRun 'Update Pi and Ham Apps' from the Hamradio menu to install it." --borders=20 & YAD_PIDs+=( $! ) fi # Set up a notebook with the 3 tabs. yad --title="Direwolf TNC and pat $VERSION" --text="Direwolf TNC$AND_PAT Configuration and Operation" \ --text-align="center" --notebook --key="$ID" \ --posx=10 --posy=50 \ --buttons-layout=center \ --tab="Monitor" \ --tab="Configure TNC" \ --tab="Configure pat" \ --width="800" --height="600" \ --button="Stop Direwolf$AND_PAT and Exit":1 \ --button="Restart Direwolf$AND_PAT":0 RETURN_CODE=$? case $RETURN_CODE in 1|252) # User click Exit button or closed window. break ;; 0) # Read and handle the Configure Direwolf TNC tab yad output [[ -s $TMPDIR/CONFIGURE_TNC.txt ]] || Die "Unexpected input from dialog" IFS='|' read -r -a TF < "$TMPDIR/CONFIGURE_TNC.txt" F[_CALL_]="${TF[0]^^}" F[_ADEVICE_CAPTURE_]="${TF[1]}" F[_ADEVICE_PLAY_]="${TF[2]}" F[_ARATE_]="${TF[3]}" F[_MODEM_]="${TF[4]}" F[_PTT_]="${TF[5]}" F[_AUDIOSTATS_]="${TF[6]}" F[_AGWPORT_]="${TF[7]}" F[_KISSPORT_]="${TF[8]}" if command -v pat >/dev/null && [ -s $PAT_CONFIG ] then # Read and handle the Configure pat tab yad output [[ -s $TMPDIR/CONFIGURE_PAT.txt ]] || Die "Unexpected input from dialog" IFS='|' read -r -a TF < "$TMPDIR/CONFIGURE_PAT.txt" PAT_CALL="${TF[0]^^}" PAT_PASSWORD="${TF[1]}" PAT_LOCATOR="${TF[2]}" PAT_HTTP_PORT="${TF[3]}" PAT_TELNET_PORT="${TF[4]}" F[_PAT_HTTP_]="${TF[5]}" F[_TXDELAY_]="${TF[6]}" F[_TXTAIL_]="${TF[7]}" F[_PERSIST_]="${TF[8]}" F[_SLOTTIME_]="${TF[9]}" # Update the pat config.json file with the new data. cat $PAT_CONFIG | jq \ --arg C "$PAT_CALL" \ --arg P "$PAT_PASSWORD" \ --arg H "0.0.0.0:$PAT_HTTP_PORT" \ --arg T "0.0.0.0:$PAT_TELNET_PORT" \ --arg L "$PAT_LOCATOR" \ '.mycall = $C | .secure_login_password = $P | .http_addr = $H | .telnet.listen_addr = $T | .locator = $L' | sponge $PAT_CONFIG fi # Update the yad configuration file. echo "declare -gA F" > "$CONFIG_FILE" for J in "${!F[@]}" do echo "F[$J]='${F[$J]}'" >> "$CONFIG_FILE" done ;; esac done SafeExit