Changes between Version 2 and Version 3 of WikiStart

Timestamp:

2011-06-11 06:56:13 (13 years ago)

Author:

futzle

Comment:

Sections: Creating the device; Configuring the device.

WikiStart

@@ -13 +13 @@
 * Connect the EnviR to an always-on computer running serial-to-Ethernet gateway software, and use the [http://code.mios.com/trac/mios_ipserial/ IPSerial plugin] to add a virtual serial port to the Vera.
 
-The serial parameters are: 57600 bps, 8 data bits, 1 stop bit, no parity.
+The serial parameters are: 57600 bps, 8 data bits, no parity, 1 stop bit.
 
 == Installing the plugin files ==
@@ -27 +27 @@
 == Creating the device ==
 
+This device requires MiOS UI4.
+
+Select '''MiOS Developers''' > '''Create Device'''. Enter '''D_CurrentCostEnviR1.xml''' for '''UpnpDevFilename'''.  Enter a name for '''Description'''.  Click '''Create Device'''.
+
+Select '''MiOS Developers''' > '''Serial port configuration'''.  Assign the serial port to the newly-created device.  Set the serial parameters (57600/8/N/1).  
+
+Select '''Save''' to restart the Luup engine.  The device should appear.  By default it shows the power usage for the "whole-house" device.
+
+The plugin creates child devices for additional appliances that the EnviR console detects.  These will first appear when you reload the Luup engine.  Child devices can be renamed and assigned to rooms after the plugin creates them.  (This behaviour can be disabled.  See the section ''Configuring the device''.)
+
 == Configuring the device ==
+
+After the plugin has been installed, you can alter its configuration.  You may need an additional restart of the Luup Engine for these variables to appear.
+
+=== Main device power formula ===
+
+If you have additional transmitters, or you are not using the "whole-house" channel, you can nominate a formula to use to display the power in the main device.  The formula is a string of appliance numbers (1 to 9, or 0 for the "whole-house" channel), separated with '''+''' or '''-''' to add or subtract that appliance's power.  Subtraction is useful if an appliance is a generator such as a solar array.
+
+Edit the formula in the '''Advanced''' tab of the main device.  Put the formula into the '''Formula''' variable.  By default it is "0", meaning the whole-house channel.
+
+Example: You have your home's energy consumption transmitting on the "whole-house" channel.  You have a solar panel that feeds power into the grid on Appliance 1.  You have a workshop on your property with a separate power supply on Appliance 5.  Use the formula '''0-1+5''' to display the net power consumption of your property.
+
+=== Automatic child device detection ===
+
+By default, the plugin creates child devices for each appliance transmitter that the EnviR console can detect.  If you want to stop this, edit the '''ApplianceAutoDetect''' variable in the '''Advanced''' tab of the parent device.  When set to "0", the plugin will no longer look for new appliances.  Existing appliances are unaffected.