#!/bin/bash ##################################################################################### # ADS-B RECEIVER # ##################################################################################### # # # This script is not meant to be executed directly. # # Instead execute install.sh to begin the installation process. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # Copyright (c) 2016, Joseph A. Prochazka & Romeo Golf # # # # Permission is hereby granted, free of charge, to any person obtaining a copy # # of this software and associated documentation files (the "Software"), to deal # # in the Software without restriction, including without limitation the rights # # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # # copies of the Software, and to permit persons to whom the Software is # # furnished to do so, subject to the following conditions: # # # # The above copyright notice and this permission notice shall be included in all # # copies or substantial portions of the Software. # # # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # # SOFTWARE. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # ### VARIABLES PROJECT_ROOT_DIRECTORY="$PWD" RECEIVER_BASH_DIRECTORY="${PROJECT_ROOT_DIRECTORY}/bash" RECEIVER_BUILD_DIRECTORY="${PROJECT_ROOT_DIRECTORY}/build" DECODER_BUILD_DIRECTORY="${RECEIVER_BUILD_DIRECTORY}/ogn" DECODER_NAME="RTLSDR-OGN" DECODER_DESC="is the Open Glider Network decoder which focuses on tracking aircraft equipped with FLARM, FLARM-compatible devices or OGN tracker" DECODER_GITHUB="https://github.com/glidernet/ogn-rf" DECODER_WEBSITE="http://wiki.glidernet.org" DECODER_SERVICE_SCRIPT_NAME="rtlsdr-ogn" DECODER_SERVICE_SCRIPT_PATH="/etc/init.d/${DECODER_SERVICE_SCRIPT_NAME}" DECODER_SERVICE_SCRIPT_CONFIG="/etc/${DECODER_SERVICE_SCRIPT_NAME}.conf" DECODER_SERVICE_SCRIPT_URL="http://download.glidernet.org/common/service/rtlsdr-ogn" ## INCLUDE EXTERNAL SCRIPTS source ${RECEIVER_BASH_DIRECTORY}/variables.sh source ${RECEIVER_BASH_DIRECTORY}/functions.sh # Should be moved to functions.sh. function CheckReturnCode { if [[ $? -eq 0 ]] ; then echo -e "\t\e[97m [\e[32mDone\e[97m]\e[39m\n" else echo -e "\t\e[97m [\e[31mError\e[97m]\e[31m\n" fi } # Source the automated install configuration file if this is an automated installation. if [[ ${RECEIVER_AUTOMATED_INSTALL} -eq "true" ]] ; then source ${RECEIVER_CONFIGURATION_FILE} fi ## BEGIN SETUP if [[ ${RECEIVER_AUTOMATED_INSTALL} -eq "false" ]] ; then clear echo -e "\e[91m ${RECEIVER_PROJECT_TITLE}" fi echo -e "" echo -e "\e[92m Setting up ${DECODER_NAME} ...." echo -e "\e[93m----------------------------------------------------------------------------------------------------\e[96m" echo -e "" whiptail --backtitle "${RECEIVER_PROJECT_TITLE}" --title "${DECODER_NAME} Setup" --yesno "${DECODER_NAME} ${DECODER_DESC}. \n\nPlease note that ${DECODER_NAME} requests a dedicated SDR tuner. \n\n${DECODER_WEBSITE} \n\nContinue setup by installing ${DECODER_NAME} ?" 14 78 CONTINUESETUP=$? if [[ $CONTINUESETUP = 1 ]] ; then # Setup has been halted by the user. echo -e "\e[91m \e[5mINSTALLATION HALTED!\e[25m" echo -e " Setup has been halted at the request of the user." echo -e "" echo -e "\e[93m----------------------------------------------------------------------------------------------------" echo -e "\e[92m ${DECODER_NAME} setup halted.\e[39m" echo -e "" if [[ ! -z ${VERBOSE} ]] ; then read -p "Press enter to continue..." CONTINUE fi exit 1 fi ## ASK FOR DEVICE ASSIGNMENTS ## CHECK FOR PREREQUISITE PACKAGES echo -e "\e[95m Installing packages needed to fulfill dependencies for ${DECODER_NAME}...\e[97m" echo -e "" CheckPackage git CheckPackage rtl-sdr CheckPackage librtlsdr-dev CheckPackage libusb-1.0-0-dev CheckPackage libconfig-dev CheckPackage libfftw3-dev CheckPackage libjpeg8 CheckPackage libjpeg-dev CheckPackage libconfig9 CheckPackage procserv CheckPackage telnet CheckPackage curl CheckPackage lynx echo -e "" ## BLACKLIST UNWANTED RTL-SDR MODULES FROM BEING LOADED if [[ ! -f /etc/modprobe.d/rtlsdr-blacklist.conf ]] ; then echo -e "\e[33m Stopping unwanted kernel modules from being loaded..." echo -e "\e[37m" sudo tee /etc/modprobe.d/rtlsdr-blacklist.conf > /dev/null < /dev/null 2>&1 CheckReturnCode fi ### DOWNLOAD AND SET UP THE BINARIES # Create build directory if not already present. if [[ ! -d ${DECODER_BUILD_DIRECTORY} ]] ; then echo -en "\e[33m Creating build directory \"\e[37m${DECODER_BUILD_DIRECTORY}\e[33m\"...\t" mkdir ${DECODER_BUILD_DIRECTORY} CheckReturnCode fi # Enter the build directory. if [[ ! ${PWD} == ${DECODER_BUILD_DIRECTORY} ]] ; then echo -en "\e[33m Entering build directory \"\e[37m${DECODER_BUILD_DIRECTORY}\e[33m\"...\t" cd ${DECODER_BUILD_DIRECTORY} CheckReturnCode fi # Detect CPU Architecture. if [[ -z ${CPU_ARCHITECTURE} ]] ; then echo -en "\e[33m Detecting CPU architecture...\t\t\t\t\t\t" CPU_ARCHITECTURE=`uname -m | tr -d "\n\r" ` CheckReturnCode fi # Identify the correct binaries to download. case ${CPU_ARCHITECTURE} in "armv6l") # Raspberry Pi 1 DECODER_BINARY_URL="http://download.glidernet.org/rpi-gpu/rtlsdr-ogn-bin-RPI-GPU-latest.tgz" ;; "armv7l") # Raspberry Pi 2 onwards DECODER_BINARY_URL="http://download.glidernet.org/arm/rtlsdr-ogn-bin-ARM-latest.tgz" ;; "x86_64") # 64 Bit DECODER_BINARY_URL="http://download.glidernet.org/x64/rtlsdr-ogn-bin-x64-latest.tgz" ;; *) # 32 Bit (default install if no others matched) DECODER_BINARY_URL="http://download.glidernet.org/x86/rtlsdr-ogn-bin-x86-latest.tgz" ;; esac # Attempt to download and extract binaries. if [[ `echo "${DECODER_BINARY_URL}" | grep -c "^http"` -gt 0 ]] ; then # Download binaries. echo -en "\e[33m Downloading ${DECODER_NAME} binaries for ${CPU_ARCHITECTURE} architecture...\t\t" DECODER_BINARY_FILE=`echo ${DECODER_BINARY_URL} | awk -F "/" '{print $NF}' ` curl -s ${DECODER_BINARY_URL} -o ${DECODER_BUILD_DIRECTORY}/${DECODER_BINARY_FILE} > /dev/null 2>&1 CheckReturnCode # Extract binaries. echo -en "\e[33m Extracting ${DECODER_NAME} package \"\e[37m${DECODER_BINARY_FILE}\e[33m\"...\t" tar xzf ${DECODER_BINARY_FILE} -C ${DECODER_BUILD_DIRECTORY} > /dev/null 2>&1 CheckReturnCode else # Unable to download bimary due to invalid URL. echo -e "\e[33m Error invalid DECODER_BINARY_URL \"${DECODER_BINARY_URL}\"..." exit 1 fi # Change to DECODER work directory for post-build actions. cd ${DECODER_BUILD_DIRECTORY}/rtlsdr-ogn # Create named pipe if required. if [[ ! -p ogn-rf.fifo ]] ; then echo -en "\e[33m Creating named pipe...\t\t\t\t\t" sudo mkfifo ogn-rf.fifo CheckReturnCode fi # Set file permissions. echo -en "\e[33m Setting proper file permissions...\t\t\t\t\t" DECODER_SETUID_BINARIES="gsm_scan ogn-rf rtlsdr-ogn" DECODER_SETUID_COUNT="0" for DECODER_SETUID_BINARY in ${DECODER_SETUID_BINARIES} ; do DECODER_SETUID_COUNT=$((DECODER_SETUID_COUNT+1)) sudo chown root ${DECODER_SETUID_BINARY} sudo chmod a+s ${DECODER_SETUID_BINARY} done # And check that the file permissions have been applied. if [[ `ls -l ${DECODER_SETUID_BINARIES} | grep -c "\-rwsr-sr-x"` -eq ${DECODER_SETUID_COUNT} ]] ; then true else false fi CheckReturnCode # Creat GPU device if required. if [[ ! -c gpu_dev ]] ; then # Check if kernel v4.1 or higher is being used. echo -en "\e[33m Getting the version of the kernel currently running...\t\t\t" KERNEL=`uname -r` KERNEL_VERSION="`echo ${KERNEL} | cut -d \. -f 1`.`echo ${KERNEL} | cut -d \. -f 2`" CheckReturnCode if [[ ${KERNEL_VERSION} < 4.1 ]] ; then # Kernel is older than version 4.1. echo -en "\e[33m Executing mknod for older kernels...\e[97m\t\t\t\t\t" sudo mknod gpu_dev c 100 0 else # Kernel is version 4.1 or newer. echo -en "\e[33m Executing mknod for newer kernels...\e[97m\t\t\t\t\t" sudo mknod gpu_dev c 249 0 fi CheckReturnCode fi ### ASSIGN RTL-SDR DONGLE FOR RTL-SDR OGN... # Potentially obselse tuner detection code. # Check for multiple tuners... TUNER_COUNT=`rtl_eeprom 2>&1 | grep -c "^\s*[0-9]*:\s"` # Multiple RTL_SDR tuners found, check if device specified for this decoder is present. if [[ ${TUNER_COUNT} -gt 1 ]] ; then # If a device has been specified by serial number then try to match that with the currently detected tuners. if [[ -n ${OGN_DEVICE_SERIAL} ]] ; then for DEVICE_ID in `seq 0 ${TUNER_COUNT}` ; do if [[ `rtl_eeprom -d ${DEVICE_ID} 2>&1 | grep -c "Serial number:\s*${OGN_DEVICE_SERIAL}$" ` -eq 1 ]] ; then echo -en "\e[33m RTL-SDR with Serial \"${OGN_DEVICE_SERIAL}\" found at device \"${OGN_DEVICE_ID}\" and will be assigned to ${DECODER_NAME}...\e[97m\t" OGN_DEVICE_ID=${DEVICE_ID} fi done # If no match for this serial then assume the highest numbered tuner will be used. if [[ -z ${OGN_DEVICE_ID} ]] ; then echo -en "\e[33m RTL-SDR with Serial \"${OGN_DEVICE_SERIAL}\" not found, assigning device \"${TUNER_COUNT}\" to ${DECODER_NAME}...\e[97m\t" OGN_DEVICE_ID=${TUNER_COUNT} fi # Or if a device has been specified by device ID then confirm this is currently detected. elif [[ -n ${OGN_DEVICE_ID} ]] ; then if [[ `rtl_eeprom -d ${OGN_DEVICE_ID} 2>&1 | grep -c "^\s*${OGN_DEVICE_ID}:\s"` -eq 1 ]] ; then echo -en "\e[33m RTL-SDR device \"${OGN_DEVICE_ID}\" found and will be assigned to ${DECODER_NAME}...\e[97m\t" # If no match for this serial then assume the highest numbered tuner will be used. else echo -en "\e[33m RTL-SDR device \"${OGN_DEVICE_ID}\" not found, assigning device \"${TUNER_COUNT}\" to ${DECODER_NAME}...\e[97m\t" OGN_DEVICE_ID=${TUNER_COUNT} fi # Failing that configure it with device ID 0. else echo -en "\e[33m No RTL-SDR device specified, assigning device \"0\" to ${DECODER_NAME}...\e[97m\t" OGN_DEVICE_ID=${TUNER_COUNT} fi # Single tuner present so assign device 0 and stop any other running decoders, or at least dump1090-mutablity for a default install. elif [[ ${TUNER_COUNT} -eq 1 ]] ; then echo -en "\e[33m Single RTL-SDR device \"0\" detected and assigned to ${DECODER_NAME}...\e[97m\t" OGN_DEVICE_ID="0" sudo /etc/init.d/dump1090-mutability stop > /dev/null 2>&1 # No tuners present so assign device 0 and stop any other running decoders, or at least dump1090-mutablity for a default install. elif [[ ${TUNER_COUNT} -lt 1 ]] ; then echo -en "\e[33m No RTL-SDR device detected so ${DECODER_NAME} will be assigned device \"0\"...\e[97m\t" OGN_DEVICE_ID="0" sudo /etc/init.d/dump1090-mutability stop > /dev/null 2>&1 fi CheckReturnCode ## CREATE THE CONFIGURATION FILE # Use receiver coordinates if already know, otherwise populate with dummy values to ensure valid config generation. # Latitude. if [[ -z ${OGN_LATITUDE} ]] ; then if [[ -n ${RECEIVER_LATITUDE} ]] ; then OGN_LATITUDE="${RECEIVER_LATITUDE}" else OGN_LATITUDE="0.000" fi fi # Longitude. if [[ -z ${OGN_LONGITUDE} ]] ; then if [[ -n ${RECEIVER_LONGITUDE} ]] ; then OGN_LONGITUDE="${RECEIVER_LONGITUDE}" else OGN_LONGITUDE="0.000" fi fi # Altitude. if [[ -z ${OGN_ALTITUDE} ]] ; then if [[ -n ${RECIEVER_ALTITUDE} ]] ; then OGN_ALTITUDE="${RECIEVER_ALTITUDE}" else OGN_ALTITUDE="0" fi fi # Geoid separation: FLARM transmits GPS altitude, APRS uses means Sea level altitude. # To find value you can check: http://geographiclib.sourceforge.net/cgi-bin/GeoidEval # Need to derive from co-ords but will set to altitude as a placeholders. if [[ -z ${OGN_GEOID} ]] ; then if [[ -n ${RECIEVER_ALTITUDE} ]] ; then OGN_GEOID="${RECIEVER_ALTITUDE}" else OGN_GEOID="0" fi fi # Set receiver callsign for this decoder. # This should be between 3 and 9 alphanumeric charactors, with no punctuation. # Please see: http://wiki.glidernet.org/receiver-naming-convention if [[ -z ${OGN_RECEIVER_NAME} ]] ; then if [[ -n ${RECEIVERNAME} ]] ; then OGN_RECEIVER_NAME=`echo ${RECEIVERNAME} | tr -cd '[:alnum:]' | cut -c -9` else OGN_RECEIVER_NAME=`hostname -s | tr -cd '[:alnum:]' | cut -c -9` fi fi # Check for decoder specific variable, if not set then populate with dummy values to ensure valid config generation. if [[ -z ${OGN_FREQ_CORR} ]] ; then OGN_FREQ_CORR="0" fi if [[ -z ${OGN_GSM_FREQ} ]] ; then OGN_GSM_FREQ="957.800" fi if [[ -z ${OGN_GSM_GAIN} ]] ; then OGN_GSM_GAIN="35" fi if [[ -z ${OGN_WHITELIST} ]] ; then OGN_WHITELIST="0" fi # Test if config file exists, if not create it. if [[ -s ${DECODER_BUILD_DIRECTORY}/rtlsdr-ogn/${OGN_RECEIVER_NAME}.conf ]] ; then echo -en "\e[33m Using existing ${DECODER_NAME} config file at \"\e[37m${OGN_RECEIVER_NAME}.conf\e[33m\"...\e [97m\t\t" else echo -en "\e[33m Generating new ${DECODER_NAME} config file as \"\e[37m${OGN_RECEIVER_NAME}.conf\e[33m\"...\e [97m\t\t" sudo tee ${DECODER_BUILD_DIRECTORY}/rtlsdr-ogn/${OGN_RECEIVER_NAME}.conf > /dev/null 2>&1 < /dev/null 2>&1 CheckReturnCode ### INSTALL AS A SERVICE if [[ -f ${DECODER_SERVICE_SCRIPT_NAME} ]] ; then # Check for local copy of service script. if [[ `grep -c "conf=${DECODER_SERVICE_SCRIPT_CONFIG}" ${DECODER_SERVICE_SCRIPT_NAME}` -eq 1 ]] ; then echo -en "\e[33m Installing service script at \"\e[37m${DECODER_SERVICE_SCRIPT_PATH}\e[33m\"...\t\t" cp ${DECODER_SERVICE_SCRIPT_NAME} ${DECODER_SERVICE_SCRIPT_PATH} sudo chmod +x ${DECODER_SERVICE_SCRIPT_PATH} > /dev/null 2>&1 else echo -en "\e[33m Invalid service script \"\e[37m${DECODER_SERVICE_SCRIPT_NAME}\e[33m\"...\t\t\t" false fi elif [[ -n ${DECODER_SERVICE_SCRIPT_URL} ]] ; then # Otherwise attempt to download service script. if [[ `echo ${DECODER_SERVICE_SCRIPT_URL} | grep -c "^http"` -gt 0 ]] ; then echo -en "\e[33m Downloading service script to \"\e[37m${DECODER_SERVICE_SCRIPT_PATH}\e[33m\"...\t\t" sudo curl -s ${DECODER_SERVICE_SCRIPT_URL} -o ${DECODER_SERVICE_SCRIPT_PATH} sudo chmod +x ${DECODER_SERVICE_SCRIPT_PATH} > /dev/null 2>&1 else echo -en "\e[33m Invalid service script url \"\e[37m${DECODER_SERVICE_SCRIPT_URL}\e[33m\"...\t\t" false fi else # Otherwise error if unable to use local or downloaded service script echo -en "\e[33m Unable to install service script at \"\e[37m${DECODER_SERVICE_SCRIPT_PATH}\e[33m\"...\t\t" false fi CheckReturnCode # Generate and install service script configuration file. if [[ -n ${DECODER_SERVICE_SCRIPT_CONFIG} ]] ; then echo -en "\e[33m Creating service config file \"\e[37m${DECODER_SERVICE_SCRIPT_CONFIG}\e[33m\"...\t\t" sudo tee ${DECODER_SERVICE_SCRIPT_CONFIG} > /dev/null 2>&1 < #Syntax: #port user directory command args 50000 pi ${DECODER_BUILD_DIRECTORY}/rtlsdr-ogn ./ogn-rf ${OGN_RECEIVER_NAME}.conf 50001 pi ${DECODER_BUILD_DIRECTORY}/rtlsdr-ogn ./ogn-decode ${OGN_RECEIVER_NAME}.conf EOF chown pi:pi ${DECODER_SERVICE_SCRIPT_CONFIG} > /dev/null 2>&1 else false fi CheckReturnCode # Potentially obselse tuner detection code. if [[ ${TUNER_COUNT} -lt 2 ]] ; then # Less than 2 tuners present so we must stop other services before starting this decoder. echo -en "\e[33m Less than 2 tuners found so other decoders will be disabled...\t" SERVICES="dump1090-mutability" for SERVICE in ${SERVICES} ; do if [[ `service ${SERVICE} status | grep -c "Active: active"` -gt 0 ]] ; then sudo update-rc.d ${SERVICE} disable > /dev/null 2>&1 fi done CheckReturnCode fi # Configure $DECODER as a service. echo -en "\e[33m Configuring ${DECODER_NAME} as a service...\t\t\t\t" sudo update-rc.d ${DECODER_SERVICE_SCRIPT_NAME} defaults > /dev/null 2>&1 CheckReturnCode # Start the $DECODER service. echo -en "\e[33m Starting the ${DECODER_NAME} service...\t\t\t\t\t" sudo service ${DECODER_SERVICE_SCRIPT_NAME} start > /dev/null 2>&1 CheckReturnCode ## RTL-SDR OGN SETUP COMPLETE # Return to the project root directory. echo -en "\e[94m Returning to ${RECEIVER_PROJECT_TITLE} root directory...\e[97m\t" cd ${PROJECT_ROOT_DIRECTORY} CheckReturnCode echo -e "" echo -e "\e[93m-------------------------------------------------------------------------------------------------------\n" echo -e "\e[92m ${DECODER_NAME} setup is complete.\e[39m" echo -e "" read -p "Press enter to continue..." CONTINUE exit 0