Starting ospy.py from /etc/init.d

[dennyfmn]

Here’s an alternate way to automatically start opsy.py on boot instead of using /etc/rc.local. The advantage to using an /etc/init.d script is that you can easily stop opsy.py and start it again if you are developing new features in the code.

Since /etc/rc.local is only executed on boot up, it’s a little awkward to stop ospi.py and start it again without rebooting or a typing bunch of manual command lines.

This script was adapted from the Debian template in /etc/init.d/skeleton

To use, as root
copy the code below to /etc/init.d/ospi
then execute

chmod +x /etc/init.d/ospi

You will need to edit the variables
PORT=:8080
HOMEDIR=/usr/local/OSPi/
to be appropriate for your site.

To activate auto start on boot, as root, execute

update-rc.d ospi defaults

To manually start/stop ospi, as root, execute

/etc/init.d/ospi start

or

/etc/init.d/ospi stop

If you switch over to using /etc/init.d/ospi, don’t forget to comment out the lines you have added to /etc/rc.local.

Here is /etc/init.d/ospi

#! /bin/sh

### BEGIN INIT INFO

# Provides:          ospi

# Required-Start:    $remote_fs $syslog

# Required-Stop:     $remote_fs $syslog

# Default-Start:     2 3 4 5

# Default-Stop:      0 1 6

# Short-Description: Open Sprinkler Raspberry Pi

# Description:       Open Sprinkler Raspberry Pi - Raspberry Pi with

#                    Open Sprinkler base board from Ray's Hobby

### END INIT INFO



#

# To auto start on boot execute (once) as root

#

# update-rc.d ospi defaults

#

# To stop auto start on boot execute

#

# update-rc.d ospi remove

#



# Author: Denny Fox 

#

# Please remove the "Author" lines above and replace them

# with your own name if you copy and modify this script.



# Do NOT "set -e"



# PATH should only include /usr/* if it runs after the mountnfs.sh script

PATH=/sbin:/usr/sbin:/bin:/usr/bin

DESC="Open Sprinkler Raspberry Pi"

HOST=$(hostname -I | sed 's/ *$//g')

PORT=:8080

NAME=ospi.py

DAEMON=/usr/bin/python

DAEMON_ARGS="ospi.py $HOST$PORT"

HOMEDIR=/usr/local/OSPi/

PIDFILE=/var/run/$NAME.pid

SCRIPTNAME=/etc/init.d/$NAME



# Exit if the package is not installed

[ -x "$DAEMON" ] || exit 0



# Read configuration variable file if it is present

[ -r /etc/default/$NAME ] && . /etc/default/$NAME



# Load the VERBOSE setting and other rcS variables

. /lib/init/vars.sh



# Define LSB log_* functions.

# Depend on lsb-base (>= 3.2-14) to ensure that this file is present

# and status_of_proc is working.

. /lib/lsb/init-functions



#

# Function that starts the daemon/service

#

do_start()

{

# Return

#   0 if daemon has been started

#   1 if daemon was already running

#   2 if daemon could not be started

start-stop-daemon --start --quiet --chdir $HOMEDIR --pidfile $PIDFILE --make-pidfile --background --exec $DAEMON --test > /dev/null 

|| return 1

start-stop-daemon --start --quiet --chdir $HOMEDIR --pidfile $PIDFILE --make-pidfile --background --exec $DAEMON -- 

$DAEMON_ARGS 

|| return 2

# Add code here, if necessary, that waits for the process to be ready

# to handle requests from services started subsequently which depend

# on this one.  As a last resort, sleep for some time.

}



#

# Function that stops the daemon/service

#

do_stop()

{

# Return

#   0 if daemon has been stopped

#   1 if daemon was already stopped

#   2 if daemon could not be stopped

#   other if a failure occurred

start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE

RETVAL="$?"

[ "$RETVAL" = 2 ] && return 2

# Wait for children to finish too if this is a daemon that forks

# and if the daemon is only ever run from this initscript.

# If the above conditions are not satisfied then add some other code

# that waits for the process to drop all resources that could be

# needed by services started subsequently.  A last resort is to

# sleep for some time.

start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON

[ "$?" = 2 ] && return 2

# Many daemons don't delete their pidfiles when they exit.

rm -f $PIDFILE

return "$RETVAL"

}



#

# Function that sends a SIGHUP to the daemon/service

#

do_reload() {

#

# If the daemon can reload its configuration without

# restarting (for example, when it is sent a SIGHUP),

# then implement that here.

#

start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME

return 0

}



case "$1" in

start)

[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"

do_start

case "$?" in

0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;

2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;

esac

;;

stop)

[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"

do_stop

case "$?" in

0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;

2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;

esac

;;

status)

status_of_proc "$DAEMON" "$NAME" && exit 0 || exit $?

;;

#reload|force-reload)

#

# If do_reload() is not implemented then leave this commented out

# and leave 'force-reload' as an alias for 'restart'.

#

#log_daemon_msg "Reloading $DESC" "$NAME"

#do_reload

#log_end_msg $?

#;;

restart|force-reload)

#

# If the "reload" option is implemented then remove the

# 'force-reload' alias

#

log_daemon_msg "Restarting $DESC" "$NAME"

do_stop

case "$?" in

0|1)

do_start

case "$?" in

0) log_end_msg 0 ;;

1) log_end_msg 1 ;; # Old process is still running

*) log_end_msg 1 ;; # Failed to start

esac

;;

*)

# Failed to stop

log_end_msg 1

;;

esac

;;

*)

#echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2

echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2

exit 3

;;

esac



:

[Dan in CA]

Thanks Denny,

That looks really useful.
I used the rc.local method because I wanted to keep things as simple as possible for the new user. I will give your script a test run.

Is it OK with you if I incorporate your script into the interval program documentation on the wiki?

Dan

[dennyfmn]

Hi Dan,

Sure, feel free to post it elsewhere. I’m hoping that others will get some use from it.

Denny

[Author]

Posts