Skip to content

Commit

Permalink
Base: Major upgrade to v3.0
Browse files Browse the repository at this point in the history
This changes the entire web app from using a PHP dependent server side
script to 100% browser based application. The files are all static
content able to be run from the file level.
  • Loading branch information
salbahra committed Feb 21, 2014
1 parent 5d7c4d1 commit 16186e3
Show file tree
Hide file tree
Showing 9 changed files with 1,717 additions and 2,006 deletions.
48 changes: 18 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
[OpenSprinkler Hosted Controller](http://salbahra.github.io/OpenSprinkler-Hosted-Controller)
========================

A mobile frontend for the OpenSprinkler irrigation device. Designed to allow manual control, program management (view, edit, delete and add), initiate a run-once program, view status, adjust rain delay, and change OpenSprinkler settings.

This version is designed for multiple users and uses no central storage. This version does not have the logging feature and also lacks weather based rain delay. Please see the main version of this software [here](https://github.com/salbahra/OpenSprinkler-Controller)
A mobile frontend for the OpenSprinkler irrigation device. Designed to allow manual control, program management (view, edit, delete and add), initiate a run-once program, view status, adjust rain delay, and change OpenSprinkler settings. Screenshots available below.

Overview:
---------

+ This application interfaces with the interval program on the OpenSprinkler which is the default software available. The application has been tested on firmware version 2.0.0 but should be compatible with 1.8.x and newer.

+ This software requires direct access to your OpenSprinkler which may require port forwarding.
+ The provided interface does not rely on the javascript files hosted by Ray therefore will work on a locally hosted server even without an internet connection (with the local asset option enabled, which is disabled by default). However an internet connection (with a properly configured web server and port forwarding) will allow you to access the application from anywhere.

+ The application is written in Javascript and HTML/CSS.

+ For current discussion about the project please refer to the [forum post](http://rayshobby.net/phpBB3/viewtopic.php?f=2&t=154).

Expand All @@ -23,42 +23,30 @@ Very well put together by Ray, thanks!
Screenshots:
------------

![Splash Screen](http://albahra.com/journal/wp-content/uploads/2013/07/startup-iphone5-retina-175x300.png) ![Home Screen](http://albahra.com/journal/wp-content/uploads/2013/07/iOS-Simulator-Screen-shot-Jul-18-2013-6.36.32-PM-169x300.png) ![Status Page](http://albahra.com/journal/wp-content/uploads/2013/07/iOS-Simulator-Screen-shot-Jul-23-2013-6.24.41-PM-169x300.png) ![Program Preview](http://albahra.com/journal/wp-content/uploads/2013/07/iOS-Simulator-Screen-shot-Jul-2-2013-10.46.37-PM-169x300.png) ![Program Editor](http://albahra.com/journal/wp-content/uploads/2013/07/iOS-Simulator-Screen-shot-Jul-27-2013-5.55.42-PM-169x300.png) ![Manual Program](http://albahra.com/journal/wp-content/uploads/2013/07/iOS-Simulator-Screen-shot-Jul-2-2013-10.30.53-PM-169x300.png) ![Rain Delay](http://albahra.com/journal/wp-content/uploads/2013/07/iOS-Simulator-Screen-shot-Jul-2-2013-10.56.03-PM-169x300.png) ![Run Once](http://albahra.com/journal/wp-content/uploads/2013/07/iOS-Simulator-Screen-shot-Jul-31-2013-8.40.23-PM-169x300.png) ![Settings](http://albahra.com/journal/wp-content/uploads/2013/08/iOS-Simulator-Screen-shot-Aug-1-2013-6.52.25-PM-169x300.png)


Raspberry Pi Users:
-------------------
![Splash Screen](http://albahra.com/journal/wp-content/uploads/2013/07/startup-iphone5-retina-175x300.png) ![Home Screen](http://albahra.com/journal/wp-content/uploads/2014/02/iOS-Simulator-Screen-shot-Jan-26-2014-7.15.37-PM-169x300.png) ![Status Page](http://albahra.com/journal/wp-content/uploads/2014/02/iOS-Simulator-Screen-shot-Jan-26-2014-7.15.45-PM-169x300.png) ![Program Preview](http://albahra.com/journal/wp-content/uploads/2014/02/iOS-Simulator-Screen-shot-Feb-9-2014-4.25.52-PM-169x300.png) ![Program Editor](http://albahra.com/journal/wp-content/uploads/2014/02/iOS-Simulator-Screen-shot-Jan-26-2014-7.24.09-PM-169x300.png) ![Manual Program](http://albahra.com/journal/wp-content/uploads/2014/02/iOS-Simulator-Screen-shot-Jan-26-2014-7.24.18-PM-169x300.png) ![Rain Delay](http://albahra.com/journal/wp-content/uploads/2014/02/iOS-Simulator-Screen-shot-Feb-9-2014-4.23.45-PM-169x300.png) ![Run Once](http://albahra.com/journal/wp-content/uploads/2014/02/iOS-Simulator-Screen-shot-Jan-26-2014-7.24.54-PM-169x300.png) ![Settings](http://albahra.com/journal/wp-content/uploads/2014/02/iOS-Simulator-Screen-shot-Feb-9-2014-4.26.09-PM-169x300.png)

+ The application should also operate on the OpenSprinkler for Raspberry Pi so long the Raspberry Pi has the interval program installed. More information is available on [Ray's Blog Post](http://rayshobby.net/?p=6339).
+ This is a seperate program that needs to be running on the Raspberry Pi.
+ Please rememeber this is a front end for a hardware device. In the case of the OpenSprinkler Pi, the hardware happens to be the Pi combined with the interval program software.

+ In order for the interval program to be 100% compatibile with the web app you must be using an interval program built on or after June 22, 2013.

Install Instructions:
---------------------

+ You first need a working OpenSprinkler setup that you can access via a browser
+ For further information please refer to the OpenSprinkler online user manual available on [Ray's Website](http://rayshobby.net/?page_id=192)

+ Install prerequisites as needed (example for Debian using Apache web server)
+ ```apt-get install apache2 php5 libapache2-mod-php5 git```
```sh
#install files
git clone https://github.com/salbahra/OpenSprinkler-Hosted-Controller.git /var/www/sprinklers

+ Create the directory you wish to place the files in (ex. /var/www/sprinklers for http://yourwebsite/sprinklers)
+ ```mkdir -m 777 /var/www/sprinklers```
```
> If you don't have Git, you can download the [ZIP](https://github.com/salbahra/OpenSprinkler-Controller/archive/master.zip) file and extract to a local directory.
+ Download the files to your web directory using git
+ ```git clone https://github.com/salbahra/OpenSprinkler-Hosted-Controller.git /var/www/sprinklers```
+ Now, visit the site using any browser (replacing IPAddr with the server IP): http://IPAddr/sprinklers

+ From there you may attempt to access the front end which will guide you through the rest of the install process.
> The webapp can also be installed to the SD card of the OpenSprinkler and run directly from the device. For this you will need to grab the specially formatted version from the sdcard branch.
Update Instructions:
--------------------

+ Navigate to the web directory where the files are stored
+ ```cd /var/www/sprinklers```

+ Trigger a remote update using git
+ ```git pull```
```sh
#change to the install directory
cd /var/www/sprinklers

[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/87d3c8783710e88024be2bf608fe8195 "githalytics.com")](http://githalytics.com/salbahra/OpenSprinkler-Controller)
#perform update
git pull
```
6 changes: 0 additions & 6 deletions config.php

This file was deleted.

1 change: 0 additions & 1 deletion css/jquery.mobile.flatui.min.css

This file was deleted.

Loading

0 comments on commit 16186e3

Please sign in to comment.