check in OSPi hardware design and software demos

Author: rayshobby

OpenSprinkler Pi/hardware/ospi_v10.brd

@@ -0,0 +1,51 @@
+============================================
+OpenSprinkler Pi (OSPi) Google Calendar Demo
+Feb 2013, http://rayshobby.net
+============================================
+
+Description
+-----------
+This demo makes use of a public Google calendar to program water events. To do so, you need to first create a public Google calendar, set the calendar ID in the Python program, then the program will periodically queries the calendar to check which stations are scheduled to be on at the current time. Each calendar event is treated as a water program, where the title of the event is the station name.
+
+Using the Google calendar provides the advantage that you can easily set recurring events. Also, you can access Google calendar on both desktop and mobile computers. It is a convenient and suitable interface for programming complex water schedules.
+
+
+Preparation
+-----------
+1. Before running this demo, it is assumed that you have the RPi.GPIO Python module installed (which should come by default with the latest raspbian distribution).
+
+
+2. In addition, you need to install the Google Data (gdata) API Python module, available at:
+http://code.google.com/p/gdata-python-client/downloads/list
+
+
+3. As mentioned above, you need to create a Google calendar, set it to be public, and copy the calendar ID (available in the calendar settings page) to the correpsonding location in ospi_gc.py. For exmaple:
+
+CALENDAR_ID = 'ma2lg95i25jantdiciij85aq0s@group.calendar.google.com'
+
+The reason to set the calendar public is to avoid the complexity of account authentication. If you need, you can also use a private calendar, but in that case you should follow the Google Data API for the appropriate authentication procedure.
+
+
+4. Next, set desired station names in ospi_gc.py. For each station, provide the station name and the corresponding station index (the first station is indexed 0). The station name will be used to match the Google calendar event title, and if a match is found, the corresponding station will be set to open. For example, an event named 'Front Yard' scheduled for every Monday morning from 9am to 10am will trigger the Front Yard station weekly during the designated time.
+
+Note that the station names are ***case sensitive***. So 'Front Yard' is different from 'Front yard'. Also, 'Front Yard' is different from 'FrontYard'. So be careful, otherwise the program will not be able to match the calendar events correctly.
+
+Note that you can map multiple names to the same station. For example, map 'Front Yard', 'FrontYard', 'Front_Yard' all to index 1. This can help avoid mismatches if you don't remember the name exactly.
+
+
+Running the Demo
+----------------
+To run the demo, type in command line:
+> sudo python ospi_gc.py
+
+The program will check the specified Google calendar once every minute (60 seconds). The frequency can be increased or decreased by modifying the sleep() time in the source code. All events that overlap with the current time will trigger the corresponding stations.
+
+
+Error Handling
+--------------
+If the program cannot access Google calendar (e.g. due to lost connection), it will reset all stations to prevent them from potentially running for a long time. Also, if an event title has no matched station name, that event will be ignored and will not trigger any station. 
+
+The program also outputs the time stamp and the detected stations. This can be used as an event log.
+
+Because the program requires Internet connection to run properly, it is not suitable in cases that the network is unreliable. It is possible to introduce a data cache to pre-load the events whenever the network is available. 
+

OpenSprinkler Pi/hardware/ospi_v10.sch

@@ -0,0 +1,147 @@
+#!/usr/bin/python
+
+import time
+import sys
+import string
+import datetime
+import RPi.GPIO as GPIO
+import atexit
+
+try:
+  from xml.etree import ElementTree # for Python 2.5 users
+except ImportError:
+  from elementtree import ElementTree
+import gdata.calendar
+import gdata.calendar.service
+
+# ======================================================
+# !!! MODIFY THE CALENDAR ID AND STATION NAMES BELOW !!!
+# ======================================================
+
+# PUBLIC GOOGLE CALENDAR ID
+# - the calendar should be set as public
+# - calendar id can be found in calendar settings
+# - !!!!!!!! PLEASE CHANGE THIS TO YOUR OWN CALENDAR ID !!!!!!
+CALENDAR_ID = 'ma2lg95i25jantdiciij85aq0s@group.calendar.google.com'
+
+# STATION NAMES
+# - specify the name : index for each station
+# - station index starts from 0
+# - station names are case sensitive
+# - you can define multiple names for each station
+
+STATIONS = {
+  "master" 		: 0,
+
+  "front yard"		: 1,  # you can map multiple common names
+  "frontyard"		: 1,  # to the same station index
+
+  "back yard"		: 2,
+  "backyard"		: 2,
+
+  "s04"	: 3,
+  "s05" : 4,
+  "s06" : 5,
+
+  "s09" : 8,
+  "s10" : 9,
+
+  "s16" : 15
+}
+
+# ======================================================
+
+# MAXIMUM NUMBER OF STATIONS
+MAX_NSTATIONS = 64
+
+# OSPI PIN DEFINES
+pin_sr_clk =  4
+pin_sr_noe = 17
+pin_sr_dat = 21
+pin_sr_lat = 22
+
+calendar_service = gdata.calendar.service.CalendarService()
+query = gdata.calendar.service.CalendarEventQuery(CALENDAR_ID, 'public', 'full')
+query.orderby = 'starttime'
+query.singleevents = 'true'
+query.sortorder = 'a'
+station_bits = [0]*MAX_NSTATIONS
+
+def enableShiftRegisterOutput():
+    GPIO.output(pin_sr_noe, False)
+
+def disableShiftRegisterOutput():
+    GPIO.output(pin_sr_noe, True)
+
+def shiftOut(station_bits):
+    GPIO.output(pin_sr_clk, False)
+    GPIO.output(pin_sr_lat, False)
+    for s in range(0,MAX_NSTATIONS):
+        GPIO.output(pin_sr_clk, False)
+        GPIO.output(pin_sr_dat, 1 if (station_bits[MAX_NSTATIONS-1-s]==1) else 0)
+        GPIO.output(pin_sr_clk, True)
+    GPIO.output(pin_sr_lat, True)
+
+
+def runOSPI():
+
+  global station_bits
+  now = datetime.datetime.utcnow();
+  print datetime.datetime.now();
+  nextminute = now + datetime.timedelta(minutes=1)
+
+  query.start_min = now.isoformat()
+  query.start_max = nextminute.isoformat()
+
+  station_bits = [0]*MAX_NSTATIONS;
+  try:
+    feed = calendar_service.CalendarQuery(query)
+    print '(',
+    for i, an_event in enumerate(feed.entry):
+      if (i!=0):
+        print ',',
+      try:
+        print an_event.title.text,
+        station_bits[STATIONS[an_event.title.text]] = 1;
+      except:
+        print "-> #name not found#",
+#      print '%s' % (an_event.title.text)
+    print ')'
+  except:
+    print "#error getting calendar data#"
+  try:
+    shiftOut(station_bits)
+  except:
+    print "#shiftOut error#"
+      
+def main():
+  print('OpenSprinkler Pi has started...')
+
+  GPIO.cleanup()
+  # setup GPIO pins to interface with shift register
+  GPIO.setmode(GPIO.BCM)
+  GPIO.setup(pin_sr_clk, GPIO.OUT)
+  GPIO.setup(pin_sr_noe, GPIO.OUT)
+  disableShiftRegisterOutput()
+  GPIO.setup(pin_sr_dat, GPIO.OUT)
+  GPIO.setup(pin_sr_lat, GPIO.OUT)
+
+  shiftOut(station_bits)
+  enableShiftRegisterOutput()
+
+  while True:
+    try:
+      runOSPI()
+    except:
+      pass
+    time.sleep(60)  # check every 60 seconds
+ 
+def progexit():
+  global station_bits
+  station_bits = [0]*MAX_NSTATIONS
+  shiftOut(station_bits)
+  GPIO.cleanup()
+
+if __name__ == "__main__":
+  atexit.register(progexit)
+  main()

OpenSprinkler Pi/hardware/ospi_v10_sch.png

@@ -0,0 +1,34 @@
+===========================================
+OpenSprinkler Pi (OSPi) Manual_Buttons Demo
+Feb 2013, http://rayshobby.net
+===========================================
+
+Description
+-----------
+This demo starts a Python HTTP server, which presents a simple webpage with a list of buttons, each corresponding to a stations. Clicking on each button to manually turn on/off a station.
+
+Before running this demo, it is assumed that you have the RPi.GPIO Python module installed (which should come by default with the latest raspbian distribution).
+
+To run the demo, type in command line:
+> sudo python ospi_manual.py
+
+This will start the Python HTTP server. Next, open a browser, and type into the following url:
+
+http://raspberrypi:8080
+
+or alternatively:
+
+http://x.x.x.x:8080
+
+where x.x.x.x is the ip address of your Raspi.
+
+You should see a list of 16 buttons. Clicking on each button to toggle the corresponding station.
+
+
+Modification
+------------
+You can change the number of stations by modifying the 'num_stations' variable in ospi_manual.py. 
+
+The code consists of two files: ospi_manual.py runs the HTTP server and maintains station variables; the webpage is formatted using the Javascripts in manual.js. You can follow the examples to extend the functionality of this demo.
+
+

OpenSprinkler Pi/software/demos/gcalendar/README.txt

@@ -0,0 +1,15 @@
+function id(s) {return document.getElementByid(s);}
+function w(s) {document.write(s);}
+function action_cv(i,v) {window.location=('./cv?sid='+i+'&v='+v);}
+w('<h3><b>OpenSprinkler Pi Manual Mode</b></h3>');
+var i,s;
+for(i=0;i<nstations;i++) {
+   w('<p>Station '+((i+1)/10>>0)+((i+1)%10)+': <button style=\"width:100;height:28;background-color:');
+   s=values[i];
+   if(s) {
+       w('lightgreen\" onclick=action_cv('+i+',0)>Turn Off');
+   } else {
+       w('lightgray\" onclick=action_cv('+i+',1)>Turn On');
+   }
+   w('</button></p>');
+}

OpenSprinkler Pi/software/demos/gcalendar/ospi_gc.py

@@ -0,0 +1,120 @@
+#!/usr/bin/env python
+
+from BaseHTTPServer import BaseHTTPRequestHandler, HTTPServer
+import urlparse
+import os
+import RPi.GPIO as GPIO
+import atexit
+
+# GPIO PIN DEFINES
+pin_sr_clk =  4
+pin_sr_noe = 17
+pin_sr_dat = 21
+pin_sr_lat = 22
+
+# NUMBER OF STATIONS
+num_stations = 16
+
+# STATION BITS 
+values = [0]*num_stations
+
+def enableShiftRegisterOutput():
+    GPIO.output(pin_sr_noe, False)
+
+def disableShiftRegisterOutput():
+    GPIO.output(pin_sr_noe, True)
+
+def setShiftRegister(values):
+    GPIO.output(pin_sr_clk, False)
+    GPIO.output(pin_sr_lat, False)
+    for s in range(0,num_stations):
+        GPIO.output(pin_sr_clk, False)
+        GPIO.output(pin_sr_dat, values[num_stations-1-s])
+        GPIO.output(pin_sr_clk, True)
+    GPIO.output(pin_sr_lat, True)
+
+#Create custom HTTPRequestHandler class
+class KodeFunHTTPRequestHandler(BaseHTTPRequestHandler):
+    
+    #handle GET command
+    def do_GET(self):
+        global values
+        rootdir = '.' #file location
+        try:
+            if self.path.endswith('.js'):
+                f = open(rootdir + self.path) #open requested file
+
+                #send code 200 response
+                self.send_response(200)
+
+                #send header first
+                self.send_header('Content-type','text/html')
+                self.end_headers()
+
+                #send file content to client
+                self.wfile.write(f.read())
+                f.close()
+                return
+            elif '/cv?' in self.path:
+                self.send_response(200)
+                self.send_header('Content-type','text/html')
+                self.end_headers()
+                parsed=urlparse.parse_qs(urlparse.urlparse(self.path).query)
+                sn = int(parsed['sid'][0])
+                v  = int(parsed['v'][0])                        
+                if sn<0 or sn>(num_stations-1) or v<0 or v>1:
+                    self.wfile.write('<script>alert(\"Wrong value!\");</script>');
+                else:
+                    if v==0:
+                        values[sn] = 0
+                    else:
+                        values[sn] = 1
+                    setShiftRegister(values)
+
+                self.wfile.write('<script>window.location=\".\";</script>')
+            else:
+                self.send_response(200)
+                self.send_header('Content-type','text/html')
+                self.end_headers()
+                self.wfile.write('<script>\nvar nstations=')
+                self.wfile.write(num_stations)
+                self.wfile.write(', values=[')
+                for s in range(0,num_stations):
+                    self.wfile.write(values[s])
+                    self.wfile.write(',')
+                self.wfile.write('0];\n</script>\n')
+                self.wfile.write('<script src=\'manual.js\'></script>')
+
+        except IOError:
+            self.send_error(404, 'file not found')
+    
+def run():
+    GPIO.cleanup()
+    # setup GPIO pins to interface with shift register
+    GPIO.setmode(GPIO.BCM)
+    GPIO.setup(pin_sr_clk, GPIO.OUT)
+    GPIO.setup(pin_sr_noe, GPIO.OUT)
+    disableShiftRegisterOutput()
+    GPIO.setup(pin_sr_dat, GPIO.OUT)
+    GPIO.setup(pin_sr_lat, GPIO.OUT)
+
+    setShiftRegister(values)
+    enableShiftRegisterOutput()
+
+    #ip and port of servr
+    #by default http server port is 8080
+    server_address = ('', 8080)
+    httpd = HTTPServer(server_address, KodeFunHTTPRequestHandler)
+    print('OpenSprinkler Pi is running...')
+    while True:
+        httpd.handle_request()
+
+def progexit():
+    global values
+    values = [0]*num_stations
+    setShiftRegister(values)
+    GPIO.cleanup()
+
+if __name__ == '__main__':
+    atexit.register(progexit)
+    run()