= 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:24/tags/0.1.4?old_path=/&format=zip Source control]
 1. Expand the ZIP File to extract the 9x files, their names should be exactly as follows:
   * `D_BrultechPowerMeter1.xml`
   * `S_BrultechPowerMeter1.xml`
   * `I_BrultechPowerMeter1.xml`
   * `I_BrultechPowerMeterRaw1.xml`
   * `D_BrultechPowerMeter1.json`
   * `D_BrultechPowerSensor1.xml`
   * `D_BrultechPowerSensor1.json`
   * `S_BrultechPowerSensor1.xml`
   * `L_BrultechMeter1.lua`
 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_BrultechPowerMeter1.xml`"
   1. For the ''!UpnpImplFilename'' field, use "`I_BrultechPowerMeter1.xml`"
   1. For the ''Description'' field, use "`Brultech`"

This will create the Brultech 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 Brultech ECM-1240, then follow these steps to associate the Serial Port with this plugin

TODO: Validate the steps for Serial ports outlined below (I use IP-enabled Brultech)

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

== Configure the Plugin ==
=== Adding More Meters ===
By default, the Plugin will configure itself for all 7 CT's that's attached to a single ECM-1240.  This can be changed by adjusting the `ActiveMeters` parameter in the Advanced Tab of the Device's dialog.

 1. Open the Dialog for the Brultech Device (using the wrench/spanner) and select the Advanced Tab[[BR]][[Image(BrultechDeviceAdvanced1.png, 30%)]]
 1. Change the value of the `ActiveMeters` parameter to be a comma-separated list of the inputs you have (1...7)[[BR]][[Image(BrultechDeviceAdvanced2.png, 30%)]]
 1. Close this Dialog and perform a MiOS ''(Save)'' action.

=== Adding More ECM-1240's ===
By default, the Plugin will configure itself for 1 (one) ECM-1240.  As the plugin "detects" ECM-1240's, it will add them to a list on a first-come, first-recorded, basis.

Over time, these devices can be seen via the `ActiveDevices` parameter in the Advanced Tab of the Device's dialog.

To include CT's from these additional ECM-1240's, the `ActiveMeters` parameter needs to list meters in the form:

One ECM-1240...
   !ActiveMeters=`1,2,3,4,5,6,7`

Two ECM-1240's...
   !ActiveMeters=`1,2,3,4,5,6,7,2.1,2.2,2.3,2.4,2.5,2.6,2.7`

Three ECM-1240's...
   !ActiveMeters=`1,2,3,4,5,6,7,2.1,2.2,2.3,2.4,2.5,2.6,2.7,3.1,3.2,3.3,3.4,3.5,3.6,3.7`

and so-on

=== Changing the Total Wattage computation ===
By default, the Total wattage of all Meters is computed for the Parent Brultech Device.  You can change this behavior to either Add (default), Subtract or Ignore the wattage of a particular Child Meter from the Parent.  The steps are as follows (for each child Meter Device):

 1. Open the Dialog for a child Meter Device (using the wrench/spanner).[[BR]][[Image(BrultechMeterDialog1.png, 30%)]]
 1. Change the selection to either ''(Add)'', ''(Subtract)'' or ''(Ignore)'' the wattage of this child in the Total Wattage computation.
 1. Close this Dialog and perform a MiOS ''(Save)'' action.

= Errors =
 * The Plugin doesn't yet support Binary format data directly from the device, it only works for the Plug & Play models right now.
 * The mechanism for including/excluding Meters from the Parent-device's Total Watts isn't documented.

= Releases =
 * 22-May-2011[[br]]
  Initial "pre-alpha" shown in the Forums.
 * 23-June-2011[[br]]
  Add UI support for Total wattage in the Parent, along with Adding, Subtracting or Ignoring each child from these Totals.
 * 18-July-2011[[br]]
  Add support for multiple ECM-1240's on a single !EtherBee, or Mux'd Serial Port.
 * 5-Aug-2011[[br]]
  Begin to split out code for Raw and Text implementations (shared Lua lib), add "poll" logic to see if that addresss problem observed by @smilligan in the forums wrt loss of data after a power cycle of the ECM's.