= Installation =
== Plugin Installation ==
'''WARNING:''' Please do not use the Internet Explorer "IE" Browser to install this plugin.  There have been multiple reported problems with IE being used to upload plugins via Vera's Luup Plug installation pages.

 1. Download the ZIP file from directly from [changeset:4/tags/0.1.1?old_path=/&format=zip Source control]
 1. Expand the ZIP File to extract the 9x files, their names should be exactly as follows:
   * `D_IORelay1.xml`
   * `I_IORelay1.xml`
   * `L_IORelay1.lua`
   * `S_IORelay1.xml`

 1. Follow the instructions for Plugin Installation outlined [http://wiki.micasaverde.com/index.php/Install_LUUP_Plugins Install Luup Plugins]
   1. For the ''!UpnpDevFilename'' field, use "`D_IORelay1.xml`"
   1. For the ''!UpnpImplFilename'' field, use "`I_IORelay1.xml`"
   1. For the ''Description'' field, use "`IORelay`"

This will create the IORelay device, but it's Serial Port still needs to be assigned and another Save / Restart cycle performed.

== Serial Port Assignment ==
If you're using a direct-attached [http://wiki.micasaverde.com/index.php/Serial_Supported_Hardware USB-Serial device] to attach to your IORelay ProXR Lite or Reactor Relay, then follow these steps to associate the Serial Port with this plugin.

 1. In ''MiOS developers'' -> ''Serial Port configuration'', find your newly connected USB-Serial port, and set the Baud rate to 115200[[BR]][[Image(IORelaySerialPortSetup1.png, 30%)]]
 1. Select your newly created IORelay Device in the ''Used by device'' dropdown[[BR]][[Image(IORelaySerialPortSetup2.png, 30%)]]
 1. The screen will change to this[[BR]][[Image(IORelaySerialPortSetup3.png, 30%)]]
 1. Close this Dialog and perform a MiOS ''(Save)'' action.

== Configure the Plugin ==
=== Adding More Relays or Inputs ===
By default, the Plugin will configure itself for all 8 Inputs and 2 Outputs (Relays).  This can be changed by adjusting the `Inputs` and `Outputs` parameter(s) in the Advanced Tab of the Device's dialog.

 1. Open the Dialog for the IORelay Device (using the wrench/spanner) and select the Advanced Tab[[BR]][[Image(IORelayDeviceAdvanced1.png, 30%)]]
 1. Change the value of the `Inputs` parameter to a value between 0 and 8
 1. Change the value of the `Outputs` parameter to a value between 0 and 8
 1. Close this Dialog and perform a MiOS ''(Save)'' action.

TODO: Document the `Interval` parameter for polling interval[[br]]
TODO: Document the `Control` parameter for `manual` (default), `manual-reactor` and `reactor` values

= Errors =

= Releases =
 * 27-Aug-2011[[br]]
  Initial "pre-alpha" shown in the Forums.
 * 29-Aug-2011[[br]]
  Patch the polling, which would randomly stop working using call_timer, move to call_delay.