ospi

An improved Python port of the Arduino based OpenSprinkler firmware, originally based on V 1.8.3. This is an updated version of OpenSprinkler Pi started by Dan Kimberling making better use of the power of Python.

---

OpenSprinkler Pi (ospi) Interval Program Demo

GNU GPL License
July 2014

---

UPDATES

---

February 10 2015

(Dan)

1. Added Plugin Manager plugin
2. Updated System Updater plugin
3. Added help button linked to repository wiki
4. Moved plugins to new repository
5. Includes Spanish and French translations and related bug fixes

January 9 2015

(Dan)

1. Added multiple language support
   
2. Updated timezone handling
   
3. Added software RESTART button under System Restart on Options page
   

October 7 2014

(Dan)

Incorporated changes that had taken place on Rimnco's GitHub fork into Dan's OSPi repository.

September 10 2014

(Rimco, Martin Pihrt)
Changes:

1. Added new functions in helpers.py: reboot, poweroff, restart, uptime and getIP.
   
2. Added new plugins:
   
   • System update (Rimco: Checked, tested and improved.)
     
   • Email (Rimco: Checked, tested and improved.)
     
   • SMS (Rimco: Globally checked and reformatted, not tested.)
     
   • LCD (Rimco: Globally checked and reformatted, not tested.)
     
   • Pressure Monitor (Rimco: Globally checked and reformatted, not tested.)
     
   • PCF8591 A/D converter read-out (Rimco: Globally checked and reformatted, not tested.)
     
3. Added pylcd2 library in /plugins for LCD plug-in.
   

September 9 2014

(Rimco, Dan, Samer Albahra and Andrew Radke)
Changes:

1. Fixed plugin executable bits
   
2. Removed all old txt reading functions
   
3. Improved mobile app interface
   
4. Fixed timeline display errors.
   
5. Improved version numbering (partially automatic)
   
6. Added @media CSS extension
   

August 2014

(Rimco and Dan)
Changes:

1. Improved weather level adjustment robustness, error logging and data removal.
   
2. Added on-off buttons to program page
   
3. Moved station names to JSON file
   
4. Moved options section to gv.py
   

July 22 2014

(Rimco)
Changes:

1. Split contents of the original ospi.py file into blocks that are more logical. (Should be improved even more.)
   
2. Removed numerous bugs regarding undeclared variables, unreachable code and misinterpretation of python classes. Tried to use python standards as much as possible.
   
3. Improved the way that plug-ins can adjust the water level. Each plug-in can now provide a water level adjustment which are combined by the main program.
   
4. Introduced template inheritance to solve many web-page inconsistencies and code duplication.
   
5. Fixed security issues where login-credentials were not checked. Introduced a ProtectedPage class as base class to be used for each page that should only be reachable if logged in.
   
6. Removed unused code, reduced code duplication.
   
7. Removed gv class (was not used at all) and put all global variables in the gv module itself.
   
8. Improved exception handling.
   
9. Because of the introduced template inheritance, plug-ins are now also using the same base template and are integrated better.
   
10. Improved page load speeds.
    
11. Added new weather-based water level adjustment plug-in that can change the water level depending on the history+forecast. This plug-in caches the queries made to WUnderground to reduce the number of queries, but a clean-up action needs to be added.
    
12. Removed files that should not committed to GitHub.
    
13. Removed APScheduler dependency.
    

July 11 2014

(Dan)
Changes:

1. Fixed reported bugs in the Home page irrigation timeline.
   
2. Fixed a bug that caused a momentary power pulse to stations during a cold boot.
   
3. Added error checking to Programs page to try and fix "server error".
   

June 23 2014

(Dan)
Changes:

1. A fix for the irrigation timeline on the Home page
   
2. The addidion of a "Plugins" button to the Home page
   

June 9 2014

(Dan)
Changes:
Software version 2.0 Jonathan Marsh's UI is now default under the master branch. A version based on the original UI derived from OpenSprinkler firmware 1.8.3 is still available under the branch named "firmware_based. This revision also includes several bug fixes.

May 4 2014

(Dan)
Changes, bug fixes:

1. Program now explicitly sets all valves to off at startup. Fixes a bug that sometimes valves were on at program load.
   
2. Fixed a bug that could freeze the program under certain conditions if a station name was blank.
   
3. Changing station names would not be updated properly - Fixed.
   
4. Changed how ospi.py handles time and date. Changes such as to or from daylight time are now automatic. Time zone setting it options no longer has an effect.
   
5. Plugins must now have group permission set to executable in order to load. Allows plugins to be selectively enabled/disabled.
   
6. Removed deprecated "ospi_addon.py" file from program directory.

April 4 2014

(Dan)
New plugin architecture including a plugin to support Samer's new JavaScript app

February 7 2014

(Dan)
Added support for Rain sensor and partial support for relay on OSPi Rev. 1.3.

November 12 2013

(Dan)
Modified program to run on either OSPi or OSBo

October 16 2013

(Dan)
Additions, bug fixes:

1. Fixed a bug that would cause an error in program preview when a master was enabled.
   
2. Changing to manual mode would clear rain delay setting, Setting rain delay in manual mode would switch to program mode - fixed.
   

October 11 2013

(Dan)
Additions, bug fixes:

1. Fixed a bug that would cause an error when a master was enabled and making changes to station settings.
   
2. added approve_pwd function and removed redundant code.
   
3. removed write_options function and added options.txt file to distribution.
   

October 4 2013

(jonathanmarsh)
Additions, bug fixes:

1. Improved options handling and passing logic
   
2. Added a "System Name" option to help users distinguish between multiple systems
   
3. Configurable station name length (increased default to 32)
   
4. Added logging options to options page
   

(Dan)
Additions, bug fixes:

1. Moved RasPi specific code into try-except blocks allowing program to run on multiple platforms
   
2. Added "write_options" function to create/update new style options.txt file in data directory.
   
3. Fixed a bug in new options code that prevented master station from being selected.
   
4. Fixed a bug that caused an exception when the number of expansion boards was reduced.
   

October 1 2013

Changes:

1. Changed the pin numbering option in the RPi.GPIO module from BCM to BOARD.
   

September 23 2013

Additions, bug fixes:

1. Added a new revisions page to the native web interface.
   
2. Modified the home.js file to show time zone info in the last run log near the bottom of the page.
   
3. Fixed a bug in concurrent mode that kept a station running after it's duration had expired.
   
4. Fixed a bug that would cause an exception (freeze the program) after the number of expansion boards was changed in Options.
   
5. Fixed a bug that would stop a running station and clear scheduled stations when the number of expansion boards was changed in Options.
   

September 10 2013

Additions, bug fixes:

1. Added a per-station "Ignore rain" option that allows a station to operate during rain delay or if a rain sensor detects rain.
   
2. Modified the program to use the HTTP port setting from the Options page.
   
3. Improved the way the program tracks current time. This simplified the code and should eliminate some timing bugs.
   
4. Edited Denny's init.d startup script to remove IP address and port settings no longer needed.
   

August 30 2013

Additions, bug fixes:

1. Modified the program to use only the time zone setting from the Options page and not the tz setting from the py.
   
2. Made the CPU temperature readout on the home page clickable to toggle between C and F.
   
3. Added a copy of Denny Fox's init.d auto startup script
   

August 25 2013

Additions, bug fixes:

1. Implemented improved installation and update methods using GitHub.
   
2. Modified the program to automatically create default config files on new installations. This also prevents existing settings from being overwritten.
   
3. Added a "Run now" button to the programs page. Allows a schedule program to be started at any time. This overrides (stops) any running program.
   
4. Added a readout of the Raspberry Pi's CPU temperature to the home page.
   
5. Fixed a bug that would allow a station to be stopped / started without a password ueing the HTML API.
   
6. Fixed a bug that would display an incorrect start day for a schedule program.
   

August 1 2013 Reved to firmware V 1.8.3

Now supports concurrent operation.
Additions, bug fixes:

1. Added Sequential/Concurrent option.
   
2. Added a function to detect Pi board rev and auto-configure GPIO pins for rev 1 boards.
   
3. Fixed a bug in manual mode that would cause any zone with a master association to stop the master when turned off, even if another station with a master association was still running.
   
4. Changed how ospi.py handles master zone associations. The program should now work with more than 3 expansion boards (untested in hardware but at least 5 expansion boards, 64 stations work in software).
   

July 21 2013

Bug fixes:

1. Fixed a bug that kept an in progress program running after it was disabled.
   
2. Added error checking to prevent an 'lg' KeyError
   
3. When a new program was added, it became program 1 instead of being added at the end of the list. - fixed.
   
4. When Rain Delay was set, running stations did not stop. - Fixed.
   
5. Added a 1.5s delay in the screen refresh of manual Mode to allow active stations and last run log time to update.
   

July 19 2013

Code re-factored:

1. Eliminated over 100 lines of redundant code. The code is now much closer to the micro-controller version. Manual Mode and Run-once now rely on the main loop algorithm. This eliminates potential conflicts and makes the code easier to maintain. The program should now be more stable and have fewer bugs although the UI is a little slower.
   
2. Changed bit-wise operations to make them more reliable.
   
3. Station names now accept Unicode characters allowing names to be entered in any language.
   
4. Faveicon now appears on all pages.
   
5. A small bug in the display of Master valve off time in the program preview has been fixed. The off time was 1 minute short.
   
6. A file named 'sd_reference.txt' has been added to the OSPi directory. It contains a list with descriptions of the values contained in the global settings dictionary variable (gv.sd) which holds most settings for the program. These values are kept in memory and also stored in the file OSPi/data/sd.json to persist across system restarts. This is for the benefit of anyone who wishes to tinker with the code.
   

It is recommended to re-install the entire OSPi directory from GitHub. You can keep your current settings by saving the contents of the OSPi/data directory to another location before installation, then replace the contents of the newly installed directory with your saved files.

july 10 2013

Bug fixes and additions:

1. Fixed a bug that prevented zones 9+ from running.
   
2. The Run once program was not observing the station delay setting - Fixed
   
3. Made the sd variable an attribute of the gv module. All references to sd... are now gv.sd... This should potentially fix several bugs, Specifically the Rain delay seems to be working properly now.
   
4. The Graph Programs time marker was not recognizing the time zone setting from the Options page - fixed.
   
5. Time displayed on the last run line of the main page was not correct - fixed.
   
6. Added a faveicon which will help distinguish the OpenSprinkler tabs on the browser.
   
7. Added an import statement and file which provide a stub for adding user written custom functions to the interval program without modifying the program itself.
   

Jun 26 2013

1. Last run logging is now working for manual mode when an optional time value is selected, even if more that one station is started.
   
2. Fixed a bug that prevented the home page display from updating when running irrigation programs.
   
3. Includes a fix from Samer that allows the program preview time marker to update properly.
   

Jun 20, 2013

This update includes:

1. Changed the way ospi.py handles time. It now uses the time zone setting from the OS options page. It also eliminates the auto daylight savings time adjustment that was causing problems for some users.
   
2. Fixes a bug mentioned on the forum that caused Samer's app to not update in program mode.
   
3. Fixes a bug that caused a program to re-start after the "Stop all stations" button was clicked.
   
4. A partial fix for the "last run" problems. Still need to get manual mode with an optional time setting working.
   
5. Added a docstring at the top of the ospi.py file with the date for version tracking.

Jun 19, 2013

Applied Samer Albahra's patch so that the program will work with Samer's mobile web app. Per forum discussion: http://rayshobby.net/phpBB3/viewtopic.php?f=2&t=154&start=40#p781

NOTE

This folder contains a fork of OpenSprinkler Pi written by Dan Kimberling using Python as it should be used. It is largly compatible with the microcontroller-based OpenSprinkler firmware 1.8, the instructions of which can be found at:

http://rayshobby.net/?page_id=730

The program makes use of web.py (http://webpy.org/) for the web interface.

---

Full credit goes to Dan for his generous contributions in porting the microcontroller firmware to Python.

---

================================================================

---

Installation and set up

---

For complete and up-to-date installation and set up instructions, see the Rays Hobby wiki page at: http://rayshobby.net/mediawiki/index.php?title=Python_Interval_Program_for_OSPi