GUI_moRFeus.sh

#!/bin/bash

# GUI for moRFeus (Outernet) tool with GQRX support.
# for moRFeus device v1.6 
# by LamaBleu 08/2018 - (Hydra)	
#
#
# INSTALLATION
# ========================
#
#
#    git clone https://github.com/LamaBleu/moRFeus_GUI
#    cd moRFeus_GUI
#    sudo ./GUI_moRFeus.sh
#
# At first launch the script will ask you which version (arm, 32 or 64 bits) to download
# from Outernet website archives.
# If missing, packages 'yad' 'bc' and 'socat' are also installed.
#
# GUI will not launch if moRFeus device is not connected !
#
# GQRX and step-generator :
# Using the step-generator in "VFO mode" (send freq to GQRX), will create a CSV file in ./datas/ directory.
# More over, if gnuplot and gnuplot-qt are installed, the script will draw a plot.
# Example in ./datas/ directory.
#
# To redraw a previous plot using CSV file, goto to ./datas directory, example :
#
#    cp 20180805141258.csv example.csv 
#    ./plot_example.sh 
#
#
# 
#
#
# Credits goes to Outernet and Alex OZ9AEC to give us so nice tools. Thanks !



#  Path to moRFeus directory (to morfeus_tool and this script).
#  Adapt to real path if not working.
#  Replacing $HOME by full directory path may help
# or (adapt) : export morf_tool_path=/home/user/moRFeus_GUI

export morf_tool_path=$PWD

# original user name (we are working with sudo) - adapt to real username if not working
# same here can be replaced by MORF_USER=username
# alternative : 	MORF_USER=$(ls -l $morf_tool_path/GUI_moRFeus.sh | awk '{print $3}')

export MORF_USER=$(ls -ld . | awk '{print $3}')


GNUPLOT_INSTALLED=$(dpkg-query -W -f='${Status}' gnuplot-qt 2>/dev/null | grep -c "ok installed") 
echo "GNUPlot : " $GNUPLOT_INSTALLED


####### GQRX settings - GRQX_ENABLE= to avoid 'connection refused' messages
#
# Use GQRX or not (0/1)
export GQRX_ENABLE=1
#
# 127.0.0.1 --> localhost
# to connect a remote GQRX, be sure IP is allowed on the remote side (remote control settings menu, example ::ffff:192.168.5.23).
export GQRX_IP=127.0.0.1
export GQRX_PORT=7356
export GQRX_STEP="No"
########
export stepper_step_int=0
OS=""


if [ ! -f $morf_tool_path/morfeus_tool ]; then
    echo 
    echo
    printf "\n\n\n"
    echo "#############################################"
    echo 
    echo "Username :" $MORF_USER
    echo "Directory :" $morf_tool_path
    echo "Outernet morfeus_tool not found ! "
    echo
    echo
    echo "#############################################"
    echo
    printf "\n\n\n"
    echo "Trying to download from Outernet website"
    echo
    printf "\n\n\n"
    echo -n "Choose platform type:  'arm' (Raspberry), or Linux '32' or '64' bits [32/64/arm]: " 
 
    read OS
    OS=${OS:-32}
    echo
    echo
   case $OS in
	32) echo "    **** DOWNLOAD lINUX 32 BITS VERSION";
		wget -O $morf_tool_path/morfeus_tool https://archive.othernet.is/morfeus_tool_v1.6/morfeus_tool_linux_x32
		;;
	64) echo "    DOWNLOAD lINUX 64 BITS VERSION";
		wget -O $morf_tool_path/morfeus_tool https://archive.othernet.is/morfeus_tool_v1.6/morfeus_tool_linux_x64
		;;
	arm) echo "    DOWNLOAD lINUX ARMV7 (RaspberryPi) VERSION";
		wget -O $morf_tool_path/morfeus_tool https://archive.othernet.is/morfeus_tool_v1.6/morfeus_tool_linux_armv7
		;;
   	*) echo "OS type error !"
		;;
   esac


	echo
	echo
	echo
	echo "Modify morfeus_tool ownership to $MORF_USER"
	chown $MORF_USER:$MORF_USER $morf_tool_path/morfeus_tool
	


    printf "\n\n\n" 
    printf "\n\n\n"
    echo
    echo
    echo "Just in case we will install NOW yad bc socat packages "
    echo "(sudo apt-get install yad bc socat)"
    echo
    printf "\n\n\n"
    apt-get install -y socat bc yad
fi

chmod +x $morf_tool_path/morfeus_tool
chmod -R +x $morf_tool_path/*.sh
rm /tmp/file.csv 2>/dev/null
rm /tmp/qplot.csv 2>/dev/null



export stepper_step_int=0
export GQRX_STEP="No"
ret=0

function on_click () {
yad --about 
}
export -f on_click

function generator () {
$morf_tool_path/morfeus_tool Generator
}
export -f generator

function close_exit(){

    kill -USR1 $YAD_PID
}
export -f close_exit


# sent to GQRX VFO

function gqrx_vfo_send () {
if [[ $GQRX_ENABLE -eq 1 ]];
   then
#echo "gqrx_vfo_send : F "$freq_morf_a
echo "F "$freq_morf_a > /dev/tcp/$GQRX_IP/$GQRX_PORT 2>/dev/null
setgenerator
fi
}

export -f gqrx_vfo_send

# send to GQRX LNB_LO

function gqrx_lnb_send () {
if [[ $GQRX_ENABLE -eq 1 ]];
   then
#echo "gqrx_lnb_send : LNB_LO "$freq_morf_a
echo "LNB_LO "$freq_morf_a > /dev/tcp/$GQRX_IP/$GQRX_PORT 2>/dev/null
setmixer
fi
export GQRX_LNB
export freq_morf_a

}

export -f gqrx_lnb_send

function gqrx_lnb_reset () {
if [[ $GQRX_ENABLE -eq 1 ]];
   then
echo "LNB_LO 0 " > /dev/tcp/$GQRX_IP/$GQRX_PORT 2>/dev/null
fi
GQRX_LNB=0
export GQRX_LNB
close_exit
}

export -f gqrx_lnb_reset

function remote_morfeus_receive () {

#read MESSAGE
echo "TCP receive : " $MESSAGE
$morf_tool_path/morfeus_tool setFrequency  $(($MESSAGE))


}

export -f remote_morfeus_receive


function setfreq () {
freq_morf=${status_freq%????}
#freq_morf=${status_freq::-4}
freq_morf_a="${freq_morf/$'.'/}"

INPUTTEXT=`yad  --center --width=270 --title="set Frequency" --form --text="  Now : $freq_morf kHz" --field="Number:NUM" $freq_morf_a'\!85e6..5.4e9\!1000\!0 2>/dev/null'`  
INPUTTEXT1=${INPUTTEXT%,*}

$morf_tool_path/morfeus_tool setFrequency $INPUTTEXT1



export freq_morf_a
#export INPUTTEXT1
close_exit
}
export -f setfreq




function gqrx_get () {
if [[ $GQRX_ENABLE -eq 1 ]];
   then
     GQRX_FREQ=$(echo 'f ' | socat stdio tcp:$GQRX_IP:$GQRX_PORT,shut-none 2>/dev/null) 
     GQRX_LNB=$(echo 'LNB_LO ' | socat stdio tcp:$GQRX_IP:$GQRX_PORT,shut-none 2>/dev/null)
     #echo "GQRX VFO: $GQRX_FREQ   LNB LO: $GQRX_LNB"
   else 
      echo "GQRX disabled"
fi
export GQRX_FREQ
export GQRX_LNB

}
export -f gqrx_get


function setcurrent () {

INPUTTEXT=`yad --center --width=250 --title="set Power" --form --field="Power:CB" $status_current'!0!1!2!3!4!5!6!7' 2>/dev/null`  
INPUTTEXT1=${INPUTTEXT%,3*}
#echo "setCurrent : "$INPUTTEXT1"  , "
status_current = INPUTTEXT1
$morf_tool_path/morfeus_tool setCurrent $INPUTTEXT1

export status_current
close_exit

}
export -f setcurrent

function setmixer () {

$morf_tool_path/morfeus_tool setCurrent 0
$morf_tool_path/morfeus_tool Mixer 

close_exit

}
export -f setmixer

function setgenerator () {

$morf_tool_path/morfeus_tool Generator 

close_exit
}
export -f setgenerator



function mainmenu () {

######### get status
#export morf_tool
status_mode=$($morf_tool_path/morfeus_tool getFunction)
status_current=$($morf_tool_path/morfeus_tool getCurrent)
status_freq=$($morf_tool_path/morfeus_tool getFrequency)


exec 2> /dev/null

freq_morf=${status_freq%????}
#freq_morf=${status_freq::-4}
freq_morf_a=${freq_morf/$'.'/}
#echo $freq_morf_a
export status_freq
export status_current
export freq_morf_a

gqrx_get


####### main GUI window



data="$(yad --center --title="Outernet moRFeus v1.6" --text-align=center --text=" moRFeus control \n by LamaBleu 08/2018 (Hydra) \n" \
--form --field=Freq:RO "$status_freq" --field="Mode:RO" "$status_mode" --field="Power:RO"  "$status_current"  \
--field=:LBL "" --form --field="Set Frequency:FBTN" "bash -c setfreq" \
--field="set Generator mode:FBTN" "bash -c setgenerator" \
--field="set Mixer mode:FBTN" "bash -c setmixer"  \
--field="Set Power:FBTN" "bash -c setcurrent" --field=:LBL "" \
--field='GQRX control':RO "  IP: $GQRX_IP Port: $GQRX_PORT"  \
--field='GQRX Freq':RO "VFO: $GQRX_FREQ    LNB LO: $GQRX_LNB " \
--field="Morfeus/Gen. + Freq --> GQRX (VFO):FBTN" "bash -c gqrx_vfo_send" \
--field="Morfeus/Mixer + Freq --> GQRX (LNB LO):FBTN" "bash -c gqrx_lnb_send" \
--field="Reset GQRX LNB LO to 0:FBTN" "bash -c gqrx_lnb_reset" "" "" "" "" "" "" "" "" "" ""  \
--button="Step generator:3"  --button="Refresh:0" --button="Quit:1" )"  


ret=$?
#echo $data

############# step generator


if [[ $ret -eq 3 ]]; then

# we need to switch to generator mode, and minimal power.
$morf_tool_path/morfeus_tool Generator
#$morf_tool_path/morfeus_tool setCurrent 1


#setting variables in advance i know why ;)
rm /tmp/stop 2>/dev/null
percent=0
stepper_step_int=10000
stepper_start_int=$freq_morf_a
stepper_step=10000
stepper_start_in=$(echo "$freq_morf_a" | bc)
stepper_stop_in=$(echo "$freq_morf_a" | bc)
stepper_step_in=10000
stepper_hop=5.0
#stepper_hop1=5
stepper="No"
stepper_step="10000"
stepper_start=$freq_morf_a
stepper_stop=$freq_morf_a
stepper_stop_int=$freq_morf_a
#$morf_tool_path/morfeus_tool setCurrent 1
############

stepper="$(yad  --center --width=320 --title="start Frequency" --form --text="  Now : $freq_morf kHz" \
--field="Start_freq:NUM" $freq_morf_a.'\!85e6..5.4e9\!100000\!0' \
--field="Stop_freq:NUM" $freq_morf_a'.\!85e6..5.4e9\!100000\!0' \
--field="Step Hz:NUM" $stepper_step_int'.\!0..1e9\!10000\!0' \
--field="Hop (s.):NUM" '5.\!1..3600\!0.5\!1' \
--field="Power:CB" $status_current'\!0!1!2!3!4!5!6!7' \
--field="Send Freq to GQRX:CB" $GQRX_STEP'\!No!VFO!LNB_LO'  "" "" "" "" "" "" ) "



#ret_step=$?
#echo "ret_step "$stepper
#export ret_step

stepper_start=$(echo $(echo $(echo "$stepper" | cut -d\| -f 1)))
stepper_stop=$(echo $(echo $(echo "$stepper" | cut -d\| -f 2)))
stepper_step=$(echo $(echo $(echo "$stepper" | cut -d\| -f 3)))
stepper_hop=$(echo $(echo $(echo "$stepper" | cut -d\| -f 4)))
stepper_current=$(echo $(echo $(echo "$stepper" | cut -d\| -f 5)))
GQRX_STEP=$(echo $(echo $(echo "$stepper" | cut -d\| -f 6)))

#echo $stepper
stepper_start="${stepper_start//,/$'.'}"
stepper_stop="${stepper_stop//,/$'.'}"
stepper_step="${stepper_step//,/$'.'}"
stepper_hop="${stepper_hop//,/$'.'}"

stepper_step_int=${stepper_step%%.*}
stepper_start_int=${stepper_start%%.*}
stepper_stop_int=${stepper_stop%%.*}
stepper_hop_int=${stepper_hop%%?????}
stepper_current_int=${stepper_current%%.*}

#echo $stepper_start_int
#echo $stepper_stop
i=$((stepper_start_int))
#echo $i
end=$((stepper_stop_int))
band=$(((end-i)/stepper_step_int))
band=${band#-}

#echo $i $end $band


echo "Fstart: "$i " Fend: " $end " Step Hz: "$stepper_step_int "Hop-time: "$stepper_hop_int
echo " Jumps: " $(expr $band + 1) "  Power : "$stepper_current_int "  GQRX : "$GQRX_STEP

# we need to switch to generator mode, and minimal power.
$morf_tool_path/morfeus_tool Generator
$morf_tool_path/morfeus_tool setCurrent $stepper_current



if [[ $GQRX_ENABLE -eq 1 ]];
   then
	if [[ $GQRX_STEP = "VFO" ]]; then
		#scanning start : setting GQRX LNB_LO to 0, to ensure display on correct VFO freq.
		echo "gqrx lnb_lo reset"
		echo "LNB_LO 0 " > /dev/tcp/$GQRX_IP/$GQRX_PORT 2>/dev/null
	fi
fi
k=0

#test if f_start > f_end, then launch decremental stepper
# and swap f_start f_end variables

range=$(($end-$i))
#echo $range

if [ "$range" -lt 0 ] ; then
	echo "*** Decremental steps !"
	#negative steps
	stepper_step_int=-${stepper_step_int}

  else
	echo "*** Incremental steps !"
	i=$((stepper_start_int))
	end=$(($stepper_stop_int))

fi



# number of steps
band=$((band+1))

istart=$((stepper_start_int))
#rm /tmp/stop 2>/dev/null




while [ $k -ne $band ]; do



# display a progress bar using YAD as separate task.
# caculate progress (percentage)
# can also send STOP order (cancel button)

percent=$( bc <<<"$k*100/$band") 
echo $percent > /tmp/percent


if [ -f /tmp/stop ]; then
  echo " *** received STOP signal"
  k=$((band-1))
fi


if [[ $k -eq 1 ]];   then
   sudo $morf_tool_path/progressbar.sh &
fi

# send freq to moRFeus & GQRX (if enabled)


$morf_tool_path/morfeus_tool setFrequency $i
if [[ $GQRX_ENABLE -eq 1 ]]; then

   if [[ $GQRX_STEP = "LNB_LO" ]]; then
      #send to LNB_LO
      #echo "GQRX LNB_LO:  " $i
      echo "LNB_LO "$i > /dev/tcp/$GQRX_IP/$GQRX_PORT 2>/dev/null
   fi

   if [[ $GQRX_STEP = "VFO" ]]; then
      #send to VFO
      #echo "GQRX VFO:  " $i
      echo "F "$i > /dev/tcp/$GQRX_IP/$GQRX_PORT 2>/dev/null
   fi

fi


sleep $stepper_hop
k=$((k+1))


### Using GQRX and select VFO stepper-mode: get level, store datas, create export file, and live-plot

if [[ $GQRX_STEP = "VFO" ]]; then
   # get signal level, thanks to @csete
   GQRX_LEVEL=$(echo 'l' | socat stdio tcp:$GQRX_IP:$GQRX_PORT,shut-none 2>/dev/null)
   # however sometimes received signal is 0.0 dB, 
	while [[ $GQRX_STEP = "VFO" && $GQRX_LEVEL = "0.0" ]]
	do
   		echo "Freq: $i - GQRX: bad result - try again ..."
   		sleep 0.1
  		 GQRX_LEVEL=$(echo 'l' | socat stdio tcp:$GQRX_IP:$GQRX_PORT,shut-none 2>/dev/null) 
 	done
sleep 0.15
# store freq,level values in csv file for future use (plot) :
# same as https://www.rtl-sdr.com/using-an-rtl-sdr-and-morfeus-as-a-tracking-generator-to-measure-filters-and-antenna-vswr/
# file compatible for use with rtl_power_fftw: https://github.com/AD-Vega/rtl-power-fftw/blob/master/doc/rtl_power_fftw.1.md

#store signal level to CSV file
    echo "$i $GQRX_LEVEL" >> /tmp/file.csv


# live plot
  if [ $GNUPLOT_INSTALLED -eq 1 ]; then
		rm /tmp/qplot.csv
     		#gnuplot -e "f0=$istart;fmax=$end;stepper_hop=$stepper_hop" ./qplot.gnu
	if [[ ! -z "$GQRX_LEVEL" ]] ; then
     		cp /tmp/file.csv /tmp/qplot.csv
           else
                echo "GQRX --> no link (remote control enabled?)"   
		
	fi	
      		echo $stepper_stop_int" " >> /tmp/qplot.csv
      		gnuplot -e "f0=$istart;fmax=$end;stepper_hop=$stepper_hop;k=$k;band=$band" $morf_tool_path/qplot.gnu  &
		#implicit : live-plot will not be displayed if "GQRX no link status"
  fi      	

else
    
    GQRX_LEVEL="none"


fi
percent=$( bc <<<"$k*100/$band") 
echo $percent > /tmp/percent


echo "$percent %  -- Freq: $i - GQRX: $GQRX_STEP - Jump $k/$band   -  Level : $GQRX_LEVEL dB"




#next freq step
i=$(($i+$stepper_step_int))
#echo $i



done
echo "Stepper end.    "

#end of csv file
if [[ $GQRX_STEP = "VFO" ]]; then
  echo "#Fstart: $istart"   >> /tmp/file.csv
  echo "#Fend:  $end"   >> /tmp/file.csv
  echo "#Step: $((stepper_step_int))"  >> /tmp/file.csv
  echo "#Date: "$(date +%Y-%m-%d" "%H:%M:%S) >> /tmp/file.csv
 
fi
#we will try to plot a graph, and save it.. only if package gnuplot-qt (and obviously gnuplot) is installed
#very common by default

capture_time=$(date +%Y%m%d-%H%M%S) 


#GNUPLOT_INSTALLED
if [ $GNUPLOT_INSTALLED -eq 1 ];
#if [ $(dpkg-query -W -f='${Status}' gnuplot-qt 2>/dev/null | grep -c "ok installed") -eq 1 ];
 then
	#echo "gnuplot installed"
	
	gnuplot -persist -e "f0=$istart;fmax=$end" ./plot.gnu
        mv $morf_tool_path/datas/signal.png $morf_tool_path/datas/$capture_time.png
 else
        echo "gnuplot not installed, however data will be exported (CSV file)"
fi

if [[ $GQRX_STEP = "VFO" ]]; then
	# rename and set permissions from root to current user for new files...
	# rename the CSV file to current date-time
	mv /tmp/file.csv $morf_tool_path/datas/$capture_time.csv
	echo " CSV export :  $morf_tool_path/datas/$capture_time.csv"       
	chown $MORF_USER:$MORF_USER $morf_tool_path/datas/$capture_time.*
fi
#       	rm /tmp/file.csv
# sudo chown $MORF_USER:$MORF_USER ./datas/*
sleep 0.3
kill $(echo $(pidof sh))

fi

}



# Establish run order
main() {
#!/bin/bash
while :
do
#echo $ret

mainmenu
if [[ $ret -eq 1 ]];
   then
	echo "Normal exit"	
	break       	   #Abandon the loop. (quit button)
   fi
if [[ $ret -eq 127 ]];
   then
	echo "err 127 "
	break       	   #Abandon the loop. (error)
   fi
if [[ $ret -eq 252 ]];
   then
	echo "User cancel"
	break       	   #Abandon the loop. (close mainwindow)
   fi
#mainmenu
done 
 
}

export -f mainmenu
main