install-smartgarage.sh

#!/usr/bin/env bash

# https://github.com/geekslant/smartgarage/
version=v0.1

# The MIT License (MIT)
#
# Copyright (c) 2018 Geek Slant
#
# 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.

if [[ $EUID -ne 0 ]]; then
   echo "install-smartgarage must be run as root."
   echo "Try: sudo ./install-smartgarage"
   echo ""
   exit 1
fi

set -e

SECONDS=0
previous_part_elapsed_time=0
total_elapsed_time=0
dir=`dirname $0`
skip_camera=0
camera_password=""
camera_ip_address=""
interactive_mode=0
total_parts=10

function ask() {
    # https://djm.me/ask
    local prompt default reply

    while true; do

        if [ "${2:-}" = "Y" ]; then
            prompt="Y/n"
            default=Y
        elif [ "${2:-}" = "N" ]; then
            prompt="y/N"
            default=N
        else
            prompt="y/n"
            default=
        fi

        # Ask the question (not using "read -p" as it uses stderr not stdout)
        echo -n "$1 [$prompt] "

        # Read the answer (use /dev/tty in case stdin is redirected from somewhere else)
        read reply </dev/tty

        # Default?
        if [ -z "$reply" ]; then
            reply=$default
        fi

        # Check if the reply is valid
        case "$reply" in
            Y*|y*) return 0 ;;
            N*|n*) return 1 ;;
        esac

    done
}

function bail() {
	echo ""
	hashline
    if [ -z "$1" ]; then
        echo "Exiting due to error"
    else
        echo "Exiting due to error: $*"
    fi
    stop_timer
    show_elapsed_time
    exit 1
}

function start_timer() {
	SECONDS=0
}

function stop_timer() {
	previous_part_elapsed_time=$SECONDS
	let "total_elapsed_time=total_elapsed_time+previous_part_elapsed_time"
}

function show_elapsed_time() {
	let "previous_part_elapsed_time_minutes=previous_part_elapsed_time/60"
	let "previous_part_elapsed_time_seconds=previous_part_elapsed_time%60"
	let "total_elapsed_time_minutes=total_elapsed_time/60"
	let "total_elapsed_time_seconds=total_elapsed_time%60"
	echo ""
	if [ -z "$1" ]; then
		echo -n "Part Elapsed Time: "
	else
		echo -n "Part $1 Elapsed Time: "
	fi
	printf "%02d:%02d\nTotal Elapsed Time: %02d:%02d\n" $previous_part_elapsed_time_minutes $previous_part_elapsed_time_seconds $total_elapsed_time_minutes $total_elapsed_time_seconds
}

function hashline() {
	echo "###############################################################"
}

function infopart() {
	stop_timer
	let "previous_part=$1-1"
	show_elapsed_time $previous_part
	echo ""
	hashline
	echo "Part ${1}/${total_parts}:"
	echo "${2}"
	hashline
	echo ""
}

function configure_opener_and_camera() {
	echo ""
	if ask "Do you know the camera password and IP address?"; then
		echo ""
		echo "Configuring Pi Smart Garage Door Opener and HiKam S6 Camera..."
		echo ""
		while true; do
			echo -n "Camera password: "
			read camera_password </dev/tty
			echo -n "Camera IP address: "
			read camera_ip_address </dev/tty
			echo ""
			if ask "Are you sure these are correct?"; then
				skip_camera=0
				echo ""
				break
			else
				echo ""
				continue
			fi
		done
	else
		bail "The camera password and IP address are required to configure the camera."
	fi
}

function configure_opener() {
	skip_camera=1
	echo ""
	echo "Configuring Pi Smart Garage Door Opener only..."
	echo ""
}

function choose_installation_mode() {
	echo ""
	if ask "Do all steps automatically?" Y; then
		return
	else
		interactive_mode=1
	fi
}

function choose_installation_configuration() {
	local reply
	start_timer

	echo "Choose an installation configuration:"
	echo ""
	echo "0: Configure Pi Smart Garage Door Opener and HiKam S6 Camera"
	echo "1: Configure Pi Smart Garage Door Opener Only"
	echo "q: Quit"
	echo ""

	while true; do
		echo -n "0|1|q? "
		read reply </dev/tty
		case "$reply" in
			0) 
				configure_opener_and_camera 
				break
				;;
			1) 
				configure_opener 
				break
				;;
			q) exit 1 ;;
		esac
	done

	choose_installation_mode
}

function execute_step() {
	if [ ${interactive_mode} == "1" ] && !( ask "Do this step?" Y ) ; then
		echo ""
		echo "Skipping..."
		start_timer
		return 1
	fi
	echo ""
	start_timer
}

function update_package_database() {
	infopart 1 "Updating package database..."
	if execute_step ; then
		echo "$ apt-get update"
		echo ""
		apt-get update
	fi
}

function upgrade_installed_packages() {
	infopart 2 "Upgrading installed packages..."
	if execute_step ; then
		echo "$ apt-get -y upgrade"
		echo ""
		apt-get -y upgrade
	fi
}

function install_node_repo() {
	infopart 3 "Installing NodeSource Node.js v8.x repository..."
	if execute_step ; then
		echo "$ curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -"
		echo ""
		curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
	fi
}

function install_nodejs_and_npm() {
	infopart 4 "Installing Node.js and npm..."
	if execute_step ; then
		echo "$ apt-get install -y nodejs"
		echo ""
		apt-get install -y nodejs
	fi
}

function install_avahi() {
	infopart 5 "Installing Avahi..."
	if execute_step ; then
		echo "$ apt-get install -y libavahi-compat-libdnssd-dev"
		echo ""
		apt-get install -y libavahi-compat-libdnssd-dev
	fi
}

function install_ffmpeg() {
	if [ ${skip_camera} == "1" ]; then
		infopart 6 "No camera: Skipping ffmpeg installation..."
		return
	fi
	infopart 6 "Installing ffmpeg..."
	if execute_step ; then
		echo "$ apt-get install -y ffmpeg"
		echo ""
		apt-get install -y ffmpeg
	fi
}

function install_homebridge() {
	infopart 7 "Installing Homebridge..."
	if execute_step ; then
		echo "$ npm install -g --unsafe-perm homebridge"
		echo ""
		npm install -g --unsafe-perm homebridge
	fi
}

function install_homebridge_garage_door_opener_plugin() {
	infopart 8 "Installing Homebridge garage door opener plugin..."
	if execute_step ; then
		echo "$ npm install -g homebridge-rasppi-gpio-garagedoor"
		echo ""
		npm install -g homebridge-rasppi-gpio-garagedoor
	fi
}

function install_homebridge_camera_plugin() {
	if [ ${skip_camera} == "1" ]; then
		infopart 9 "No camera: Skipping Homebridge camera plugin installation..."
		return
	fi
	infopart 9 "Installing Homebridge camera plugin..."
	if execute_step ; then
		echo "$ npm install -g homebridge-camera-ffmpeg"
		echo ""
		npm install -g homebridge-camera-ffmpeg
	fi
}

function configure_homebridge() {
	infopart 10 "Configuring Homebridge..."
	if execute_step ; then
		echo ""
		if !([[ -d /var/lib/homebridge ]]) ; then
			echo "Creating /var/lib/homebridge directory..."
			echo "$ mkdir /var/lib/homebridge"
			echo ""
			mkdir /var/lib/homebridge
		else
			echo "/var/lib/homebridge directory already exists. Skipping mkdir."
		fi

		echo ""
		echo "Copying homebridge service defaults..."
		echo "$ cp ${dir}/homebridge /etc/default/"
		echo ""
		cp ${dir}/homebridge /etc/default/

		echo ""
		echo "Copying homebridge service configuration..."
		echo "$ cp ${dir}/homebridge.service /etc/systemd/system/"
		echo ""
		cp ${dir}/homebridge.service /etc/systemd/system/

		echo ""
		echo "Copying script that enables Pi GPIO pins for the garage door opener..."
		echo "$ cp ${dir}/garage-door-gpio /var/lib/homebridge/"
		echo ""
		cp ${dir}/garage-door-gpio /var/lib/homebridge/

		echo ""
		if [ ${skip_camera} == "1" ]; then
			echo "Copying Homebridge configuration..."
			echo "$ cp ${dir}/config-without-camera.json /var/lib/homebridge/config.json"
			echo ""
			cp ${dir}/config-without-camera.json /var/lib/homebridge/config.json
		else
			echo "Copying Homebridge configuration with camera settings..."
			echo "$ cp ${dir}/config-with-camera.json /var/lib/homebridge/config.json"
			echo ""
			cp ${dir}/config-with-camera.json /var/lib/homebridge/config.json

			echo ""
			echo "Inserting camera password in Homebridge configuration..."
			echo "$ sed -i \"s/PUT_CAMERA_PASSWORD_HERE/\"$camera_password\"/g\" \"/var/lib/homebridge/config.json\""
			echo ""
			sed -i "s/PUT_CAMERA_PASSWORD_HERE/"$camera_password"/g" "/var/lib/homebridge/config.json"

			echo ""
			echo "Inserting camera IP address in Homebridge configuration..."
			echo "$ sed -i \"s/PUT_CAMERA_IP_ADDRESS_HERE/\"$camera_ip_address\"/g\" \"/var/lib/homebridge/config.json\""
			echo ""
			sed -i "s/PUT_CAMERA_IP_ADDRESS_HERE/"$camera_ip_address"/g" "/var/lib/homebridge/config.json"
		fi

		echo ""
		if [ id -u homebridge &>/dev/null ]; then
			echo "Adding homebridge system user..."
			echo "$ useradd -M --system homebridge"
			echo ""
			useradd -M --system homebridge
		else
			echo "homebridge user already exists. Skipping useradd."
		fi

		echo ""
		echo "Modifying permissions for the /var/lib/homebridge directory..."
		echo "$ chmod -R 0777 /var/lib/homebridge"
		echo ""
		chmod -R 0777 /var/lib/homebridge

		echo ""
		echo "Reloading the systemd manager configuration..."
		echo "$ systemctl daemon-reload"
		echo ""
		systemctl daemon-reload

		echo ""
		echo "Enabling the homebridge service..."
		echo "$ systemctl enable homebridge"
		echo ""
		systemctl enable homebridge

		echo ""
		echo "Starting the homebridge service..."
		echo "$ systemctl start homebridge"
		echo ""
		systemctl start homebridge

		echo ""
		echo "Checking the status of the homebridge service..."
		echo "$ systemctl status homebridge"
		echo ""
		systemctl status homebridge
	fi
	stop_timer
	show_elapsed_time 10
}

clear
hashline
echo " Geek Slant Smart Garage Installation Script "
echo " ${version}"
hashline
echo ""

choose_installation_configuration

update_package_database || bail "Failed to update package database."

upgrade_installed_packages || bail "Failed to upgrade installed packages."

install_node_repo || bail "Failed to install Node.js repository."

install_nodejs_and_npm || bail "Failed to install Node.js and npm."

install_avahi || bail "Failed to install Avahi."

install_ffmpeg || bail "Failed to install ffmpeg."

install_homebridge || bail "Failed to install Homebridge."

install_homebridge_garage_door_opener_plugin || bail "Failed to install Homebridge garage door opener plugin."

install_homebridge_camera_plugin || bail "Failed to install Homebridge camera plugin."

configure_homebridge || bail "Failed to configure Homebridge."

echo ""
hashline
echo "Installation complete"
hashline