Create a start/stop script for Debian

Author: pascal-fb-martin

Makefile

@@ -25,6 +25,19 @@ houseclock: $(OBJS)
 install:
 	mkdir -p /usr/local/bin
 	cp houseclock /usr/local/bin
-	chown root:root /usr/local/bin/houseclock
-	chmod 755 /usr/local/bin/houseclock
+	cp init.debian /etc/init.d/houseclock
+	chown root:root /usr/local/bin/houseclock /etc/init.d/houseclock
+	chmod 755 /usr/local/bin/houseclock /etc/init.d/houseclock
+	if [ -e /etc/init.d/ntp ] ; then systemctl stop ntp ; systemctl disable ntp ; fi
+	systemctl daemon-reload
+	systemctl enable houseclock
+	systemctl start houseclock
+
+uninstall:
+	systemctl stop houseclock
+	systemctl disable houseclock
+	rm -f /usr/local/bin/houseclock 
+	rm -f /etc/init.d/houseclock
+	systemctl daemon-reload
+	if [ -e /etc/init.d/ntp ] ; then systemctl enable ntp ; systemctl start ntp ; fi
 

README.md

@@ -36,21 +36,33 @@ When no GPS device is available, the software acts as a NTP broadcast client, li
 * make
 * sudo make install
 
-# Quick Start
+This installs HouseClock as a service (for Debian's systemd) and starts it. If ntpd was installed, this stops and disables ntp.
 
-Manually run the server using the command:
-```
-houseclock
-```
-This will read from the GPS device at /dev/ttyACM0, listen for HTTP requests on the http tcp port (80) and handle NTP communication on the ntp udp port (123).
+# Configuration
+
+With default options, HouseClock will read from the GPS device at /dev/ttyACM0, listen for HTTP requests on the http tcp port (80) and handle NTP communication on the ntp udp port (123).
 
 All these default can be changed through command line options. For example, if the GPS device is different and the http port is already in use (httpd is running), one can force other values using the -http-service and -gps options:
 ```
-houseclock -http-service=8080 -gps=/dev/ttyACM1
+houseclock -http-service=8080 -gps=/dev/tty0
 ```
 
 For more information about available options, a complete help is available:
 ```
 houseclock -h
 ````
 
+The service options can be configured by creating file /etc/default/houseclock and set the following shell variables:
+
+**GPS_OPTS**: GPS related options.
+**NTP_OPTS**: NTP related options.
+**HTTP_OPTS**: HTTP related options.
+**OTHER_OPTS**: general purpose options.
+
+For example:
+```
+GPS_OPTS="-gps=/dev/tty0"
+NTP_OPTS="-ntp-period=30"
+HTTP_OPTS="-http-service=8080"
+```
+

init.debian

@@ -0,0 +1,64 @@
+#!/bin/sh
+
+### BEGIN INIT INFO
+# Provides:        ntp
+# Required-Start:  $network $remote_fs $syslog
+# Required-Stop:   $network $remote_fs $syslog
+# Default-Start:   2 3 4 5
+# Default-Stop: 
+# Short-Description: Start SNTP daemon
+### END INIT INFO
+
+PATH=/sbin:/bin:/usr/sbin:/usr/bin
+
+. /lib/lsb/init-functions
+
+DAEMON=/usr/local/bin/houseclock
+PIDFILE=/var/run/houseclock.pid
+
+test -x $DAEMON || exit 0
+
+GPS_OPTS=
+NTP_OPTS="-ntp-period=10"
+HTTP_OPTS=
+OTHER_OPTS=
+
+if [ -r /etc/default/houseclock ]; then
+	. /etc/default/houseclock
+fi
+
+
+case $1 in
+	start)
+		log_daemon_msg "Starting SNTP server" "houseclock"
+		start-stop-daemon --start --quiet --oknodo --background --pidfile $PIDFILE --make-pidfile --startas $DAEMON -- $GPS_OPTS $NTP_OPTS $HTTP_OPTS $OTHER_OPTS
+		log_end_msg $?
+  		;;
+	stop)
+		log_daemon_msg "Stopping NTP server" "houseclock"
+		start-stop-daemon --stop --quiet --oknodo --pidfile $PIDFILE --retry=TERM/30/KILL/5 --exec $DAEMON
+		log_end_msg $?
+		rm -f $PIDFILE
+  		;;
+	restart|force-reload)
+		$0 stop && sleep 2 && $0 start
+  		;;
+	try-restart)
+		if $0 status >/dev/null; then
+			$0 restart
+		else
+			exit 0
+		fi
+		;;
+	reload)
+		exit 3
+		;;
+	status)
+		status_of_proc $DAEMON "SNTP server"
+		;;
+	*)
+		echo "Usage: $0 {start|stop|restart|try-restart|force-reload|status}"
+		exit 2
+		;;
+esac
+