From 01b0198699d9871bf642930ece770d0d1be917b9 Mon Sep 17 00:00:00 2001 From: Constantin Date: Sun, 15 Sep 2013 12:45:45 +0200 Subject: [PATCH 1/1] comments and cleanup reordered and commented code for better readability added fixmes and todos --- tuerd | 60 +++++++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 40 insertions(+), 20 deletions(-) diff --git a/tuerd b/tuerd index 7cc15d6..a283f26 100755 --- a/tuerd +++ b/tuerd @@ -4,70 +4,90 @@ from datetime import datetime import RPi.GPIO as GPIO GPIO.setmode(GPIO.BOARD) +# ******** definitions ********* +# logging function +# TODO: loglevel, log like a real daemon def log (what): print (datetime.now(),what) +# send to client for information but don't care if it arrives def waynesend (conn, what): try: conn.send(what) except: log("Couldn't send %s" % str(what)) +# for command not found: do nothing with the pins and send a "0" to the client +def doNothing (conn): + log ("doing nothing") + waynesend(conn,b"0") + pass + +# commands: on a pin do a series of timed on/off switches class Pinoutput: - # actionsanddelays is a list of pairs: (bool to send, delay in seconds to wait afterwards) + # name is for logging and also used for mapping command names to instances of this class + # actionsanddelays is a list of pairs: (bool to set on pin, delay in seconds to wait afterwards) def __init__ (self, name, pinnumber, actionsanddelays): self.name = name self.pin = pinnumber self.todo = actionsanddelays GPIO.setup(pinnumber, GPIO.OUT) log ("Pin %d set to be an output pin for %s." % (pinnumber,name)) - + # actually send the signal to the pins def __call__ (self, conn): for (value,delay) in self.todo: GPIO.output(self.pin, value) log ("%s: Pin %d set to %s." % (self.name,self.pin,str(value))) time.sleep(delay) + # notify success waynesend(conn,b"1") -tuergroupid = 1005 +# ******** configuration ********* +tuergroupid = 1005 +socketname = "/run/tuer.sock" pinlist = [Pinoutput("open", 12, [(True, 0.3), (False, 5.0)]), Pinoutput("close", 16, [(True, 0.3), (False, 5.0)]), - Pinoutput("buzz", 22, [(True, 2.0), (False, 5.0)])] - -socketname = "/run/tuer.sock" + Pinoutput("buzz", 22, [(True, 2.0), (False, 0.1)])] -def doNothing (conn): - log ("doing nothing") - waynesend(conn,b"0") - pass +# ******** main ********* +# convert list of pin objects to dictionary for command lookup +pindict = {} +for pin in pinlist: + pindict[pin.name.encode()] = pin +# create socket sock = socket.socket (socket.AF_UNIX, socket.SOCK_STREAM) - +# delete old socket file and don't bitch around if it's not there try: os.unlink (socketname) except OSError: pass - +# bind socket to file name sock.bind (socketname) - +# allow only users in the tuergroup to write to the socket os.chown (socketname, 0, tuergroupid) os.chmod (socketname, stat.S_IRUSR | stat.S_IWUSR | stat.S_IRGRP | stat.S_IWGRP) - +# listen to the people, but not too many at once sock.listen(1) -pindict = {} -for pin in pinlist: - pindict[pin.name.encode()] = pin - +# main loop +# FIXME: DoS by opening socket but not sending data, because this loop is single threaded; maybe settimeout helps a bit. while True: + # accept connections conn, addr = sock.accept() - data = conn.recv (128) + # TODO: use addr to determine the client for logging + # get some data from the client (enough to hold any valid command) + data = conn.recv (32) + # log the command log("received command: %s" % str(data)) + # lookup the command, if it's not in the dict, use the doNothing function instead + # and execute the looked up command or doNothing with the connection, so it can respond to the client pindict.get(data,doNothing)(conn) + # close connection cleanly conn.close() +# FIXME will this be executed after receiving a terminating signal? GPIO.cleanup() - -- 2.30.2