= OpenSprinkler Irrigation Controller =
[[Image(http://opensprinkler.cfowl.postinbox.com/Title.png)]]

Version 1.0


= Introduction =

This plugin provides monitoring and control of an OpenSprinkler irrigation controller.  OpenSprinkler is a product manufactured by [http://rayshobby.net/?page_id=160 Rayshobby].

== Plugin Features ==

 * Mode Control : Off / Manual / Auto
 * Configure irrigation stations to be controlled
 * Station name discovery
 * Station status with UI5 icons showing activity
 * Manual station control


= Installation =
 1. Upload the attached files: "Apps > Develop Apps > Luup Files"
[[Image(http://opensprinkler.cfowl.postinbox.com/Step1.png)]]

 2. Create device: "Apps > Develop Apps > Create device" Fill in these fields:
   a. "Upnp Device Filename": "'''D_OpenSprinkler1.xml'''"
   b. "Upnp Implementation Filename": "'''I_OpenSprinkler1.xml'''" 
   c. "Ip Address": "'''Enter the IP Address of OpenSprinkler'''"
[[Image(http://opensprinkler.cfowl.postinbox.com/Step1b.png)]]
   d. Click "Create Device"
   e. Click "Reload"

 3. Navigate to the "Devices" page.  The newly created device looks like:

[[Image(http://opensprinkler.cfowl.postinbox.com/Step2.png)]]

 4. Refresh the browser (Typically pressing F5).  OpenSprinkler will show the default configuration

[[Image(http://opensprinkler.cfowl.postinbox.com/Step3.png)]]

 5. After 60 seconds the station names will be pulled from the OpenSprinkler

[[Image(http://opensprinkler.cfowl.postinbox.com/Step4.png)]]

 6. Configure various options.  e.g. Stations being controller, password, etc.

[[Image(http://opensprinkler.cfowl.postinbox.com/Step5.png)]]

 7. Note how the individual station and controller icons change state when active

[[Image(http://opensprinkler.cfowl.postinbox.com/Step7.png)]]

= Configuration Variables =
== Password ==
OpenSprinkler's default password of "opendoor" is prepopulated.  If the OpenSprinkler is configured to "Ignore passwords" then this variable is not required.

[[Image(http://opensprinkler.cfowl.postinbox.com/IgnorePassword.png)]]

== RefreshStatusSec ==
This controls how frequently the OpenSprinkler controller will be polled (in seconds).  There is no push notification from OpenSprinkler.  The lower the number the more "real time" the updates in MCV.

= Debug Mode =
By default verbose logging is switched off.  To enable logging change the following line in I_OpenSprinkler1.xml, upload and restart Luup.

Change

{{{
local DEBUG_MODE = false
}}}

To

{{{
local DEBUG_MODE = true
}}}

Debug information is written to /tmp/log/cmh/LuaUPnP.log