Changes between Version 14 and Version 15 of WikiStart


Ignore:
Timestamp:
2013-10-22 16:26:26 (7 years ago)
Author:
solivas
Comment:

Updated to reflect changes in version 1.2 of the plugin.

Legend:

Unmodified
Added
Removed
Modified
  • WikiStart

    v14 v15  
    1515=== Features === 
    1616 
    17 -Will turn HVAC system to Off, !HeatOn, !CoolOn, Energy Savings Mode, or do nothing when any of a defined set of sensors are tripped.  Optionally will use the Twilio plugin to send an SMS message when a sensor is tripped, regardless of HVAC off control setting. 
    18  
    1917-Will restore HVAC system to Off, !AutoChangeOver, !HeatOn, !CoolOn, Normal Mode (turn off Energy Saving Mode), or do nothing when sensors are no longer in a tripped state. 
    2018 
     19-Will set your thermostat to one of the modes defined in !OnMode, !OffMode, !HighTempMode and !LowTempMode.  Depending on how the plugin has been configured will dictate what mode your thermostat will be set to. 
     20 
     21-!OffMode is normally used when a Door or Window sensor is opened for the amount of time defined.  If the plugin catches that a door or window sensor has been tripped, it will then set the thermostat to !OffMode. 
     22 
     23-!HighTempMode and !LowTempMode are used when the plugin detects that a temperature sensor has tripped.  Depending on if it was a high or low temperature sensor, the thermostats will be set to the mode defined in !HighTempMode or !LowTempMode. 
     24 
     25-!OnMode is used the conditions defined above have cleared.  Additionally, the plugin will check to see if the thermostats had their modes changed, and reset the mode to what is defined in !OnMode. 
     26 
    2127 
    2228---- 
     
    4551 
    4652 
     53'''!HighTempSensors''' = a list of temperature sensors with a high temperature tripping point.  The tripping point is defined as anything that is above the value defined.[[BR]] 
     54[[BR]] 
     55'''''* Format:'''  Needs to be entered in the format of temperature sensor id#]=[tripping point]''[[BR]][[BR]] 
     56Example: 
     57 
     58{{{   
     5945=80, 78=90 
     60}}} 
     61 
     62'''!LowTempSensors''' = a list of temperature sensors with a low temperature tripping point.  The tripping point is defined as anything that is below the value defined.[[BR]][[BR]] 
     63'''''* Format:'''  Needs to be entered in the format of temperature sensor id#]=[tripping point]''[[BR]][[BR]] 
     64Example: 
     65 
     66{{{   
     6745=32, 78=65 
     68}}} 
     69 
     70 
    4771'''Refresh''' = number of seconds to wait between checking the sensors and controlling the thermostats.  Default is set to 300 seconds (5 minutes).  Min = 300, Max = 86400.  Anything set/passed outside the min/max range will be ignored, and the default of 300 will be used.  Setting this to 0 will disable the automatic polling. 
    4872 
     73Note:  To "unset" the high or low temperature sensors, replace the values of the variables with "'''*undefined*'''" (without the quotes).  This will "turn off" the checking of the high or low temperature sensors by the plugin.  This can only be done for the temperature sensors, the door/window senors are mandatory and you currently cannot use this plugin to respond to temperature sensors only. 
     74[[BR]][[BR]] 
     75The following are the temperature modes that you can set.  Note that !OnMode and !OffMode are mandatory. 
     76 
    4977'''!OnMode''' = What mode should thermostats be restored to when sensors are closed (no longer tripped) 
    5078 
     79'''!OffMode''' = What mode should thermostats be set to when sensors are open (tripped).  Also can be though of as "!Door/Window Sensor" mode, since this is the mode your thermostat will be set to when a !Door/Window Sensor is tripped. 
     80 
     81'''!HighTempMode''' = What mode should thermostats be set to when a high temperature sensor has been tripped 
     82 
     83'''!LowTempMode''' = What mode should thermostats be set to when a low temperature sensor has been tripped 
     84 
    5185Valid modes are:[[BR]] 
    52 0  = Off[[BR]] 
    53 1  = !AutoChangeOver[[BR]] 
    54 2  = !HeatOn[[BR]] 
    55 3  = !CoolOn[[BR]] 
    56 4  = Normal mode (turns off Energy Savings Mode) 
    57 99 = Do nothing (default) 
    58  
    59 '''!OffMode''' = What mode should thermostats be set to when sensors are open (tripped) 
    60  
    61 Valid modes are:[[BR]] 
    62 0  = Off[[BR]] 
     860  = Off (default for !OffMode, 99 for rest)[[BR]] 
    63871  = !HeatOn[[BR]] 
    64882  = !CoolOn[[BR]] 
    65893  = Energy Savings Mode[[BR]] 
    66 99 = Do nothing (default) 
    67  
    68 '''!NotifyMode''' = Toggles use of Twilio Plugin to send SMS message 
    69  
    70 Valid modes are:[[BR]] 
    71 0 = Disabled[[BR]] 
    72 1 = Use Twilio Plugin to send SMS[[BR]] 
    73  
    74 '''!TwilioNumber''' = Phone number to send SMS message to[[BR]] 
    75 '''!TwilioMessage''' = Message for SMS[[BR]] 
    76 '''TwilioPluginID''' = Device ID of Twilio plugin[[BR]] 
    77  
    78  
     904  = Normal mode (turns off Energy Savings Mode)[[BR]] 
     915  = !AutoChangeOver[[BR]] 
     926  = !AuxHeatOn[[BR]] 
     937  = !EconomyHeatOn[[BR]] 
     948  = !EmergencyHeatOn[[BR]] 
     959  = !AuxCoolOn[[BR]] 
     9610 = !EconomyCoolOn[[BR]] 
     9711 = !BuildingProtection[[BR]] 
     9899 = Do nothing[[BR]] 
     99[[BR]][[BR]] 
    79100'''!VerboseDebug''' - Turns on the logging of additional messages for troubleshooting 
    80101 
     
    931141 = On 
    94115 
     116'''!PriorityMode'''  = Defines if !Window/Door or Temperature events have priority for controlling your thermostats 
     117 
     1180 = Set to !OffMode (default)[[BR]] 
     1191 = Temperature (any)[[BR]] 
     1202 = High temperature[[BR]]  
     1213 = Low temperature[[BR]] 
     122 
     123When using !PriorityMode, the plugin assumes after the check that if no temperature sensors are tripped, that the system should be placed into !OffMode.   
     124 
     125'''!SafeMode''' = Defines if the more complex checking used when two or more sensors is tripped should be run even when a single sensor has tripped.  When set, if !PriorityMode is 0, your system will default to !OffMode even if a temperature sensor has been tripped. 
     126 
     1270 = Off[[BR]] 
     1281 = On (default) 
     129 
     130'''!EnergySavingsMode''' = Defines how your thermostats should be set to !EnergySavingsMode. 
     131 
     1320 = Use !SwitchPower service only (default)[[BR]] 
     1331 = Use !EnergySavingsMode operating mode only 
    95134 
    96135---- 
     
    105144 
    106145{{{ 
    107 luup.call_action("urn:wdsc-hvac-org:device:WDSC_HVAC1", "RestartPolling",{ delay= 0 }, 66) 
    108 }}} 
    109  
    110  
     146luup.call_action("urn:wdsc-hvac-org:serviceId:WDSC_HVAC1", "RestartPolling",{ delay= 0 }, 66) 
     147}}} 
     148[[BR]] 
     149Note:  How to call the functions in this plugin have changed.  Previously, they were incorrectly defined as urn:wdsc-hvac-org:device:WDSC_HVAC1.  Anyone updating to this code will need to change their LUUP code to reflect this change. 
     150[[BR]][[BR]] 
    111151This code would turn off polling for your WDSC device (assuming your plugin is device !#66) 
    112152 
     
    117157 
    118158{{{ 
    119 ] 
     159 
    120160-- ****************************************************** 
    121 -- Window, Door, and Sensor HVAC Control (WDSC HVAC) plugin v1.0 (or WDSC for short) 
     161-- Window, Door, and Sensor HVAC Control (WDSC HVAC) plugin v1.2 
    122162-- Code originally by mcvflorin and posted to 
    123163-- http://forum.micasaverde.com/index.php/topic,4327.45.html 
     
    129169--       door or window sensor is tripped.  Currently does not support internal motion sensors in this  
    130170--       version.  May be added in a future release. 
     171-- 1.1 - Implemented urn:upnp-org:serviceId:SwitchPower1 to make it easy to trigger scenes when OnMode and  
     172--       OffMode fire.  Also added icon in .json file. 
     173-- 1.2 - Implemented temperature sensor support.  By defining temperature sensors, a high and low 
     174--       limit and an action to do if each it reached or exceeded, you can control your HVAC system 
     175--       based on climate conditions.  Direct Twilio Plugin support has been removed. 
     176--               Also standardized the values used to control the settings across all modes. 
     177-- 
    131178-- 
    132179-- While I do not claim copyright for this plugin, I do feel that the following from the BSD license 
     
    134181-- is always possibility for things to not work in the way in which they were intended. 
    135182-- 
    136 -- ** USE AT YOUR OWN RISK!!  IF YOUR HVAC EQUIPMENT MELTS DOWN, BREAKS, OR CATCHES FIRE OR EXPLODES 
     183-- ** USE AT YOUR OWN RISK!!  IF YOUR HVAC EQUIPMENT MELTS DOWN, BREAKS, OR CATCHES FIRE/EXPLODES  
    137184-- ** YOU HAVE BEEN WARNED!   
    138185-- 
     
    153200-- **    http://www.gymbyl.com/programming/s2t.html 
    154201-- 
     202-- Plugin settings: 
     203-- VerboseDebug will toggle the displaying of additional log messages for troubleshooting 
     204-- 0 = Disabled (default) 
     205-- 1 = Enabled 
     206-- 
     207-- OnMode, OffMode, HTMode, LTMode can be one of the following: 
     208-- 0  = Off (default for OffMode, 99 for rest) 
     209-- 1  = HeatOn 
     210-- 2  = CoolOn 
     211-- 3  = Energy Savings Mode 
     212-- 4  = Normal mode (turns off Energy Savings Mode) 
     213-- 5  = AutoChangeOver 
     214-- 6  = AuxHeatOn 
     215-- 7  = EconomyHeatOn 
     216-- 8  = EmergencyHeatOn 
     217-- 9  = AuxCoolOn 
     218-- 10 = EconomyCoolOn 
     219-- 11 = BuildingProtection 
     220-- 99 = Do nothing 
     221-- 
     222-- PriorityMode defines if Window/Door or Temperature events have priority for controlling your HVAC 
     223-- 0 = Window/Door (default) 
     224-- 1 = Temperature (any) 
     225-- 2 = High temperature  
     226-- 3 = Low temperature 
     227-- 
     228-- EnergySavingsMode has the following options: 
     229-- 0 = Use SwitchPower service only (default) 
     230-- 1 = Use EnergySavingsMode operating mode only 
     231-- 
    155232-- ****************************************************** 
    156233}}} 
     
    176253- By default, the readVariable messages are now turned off in the logs.  Set !VerboseDebug to turn back on. 
    177254 
     255Changes in Version 1.2: 
     256 
     257Support was added for external temperature sensors.  You can define multiple sensors as high temp or low temp with a trip point. When the temperature drops below this tripping point, the mode defined in !HighTempMode for high temperature or !LowTempMode for low temperature will trigger.  This will remain valid until the high or low temp mode clears, which will result in the plugin resetting to !OnMode.  Currently when !OffMode or any of the high or low temp modes trip, it registers as the plugin turning off using the !PowerSwitch service.  A future version will implement way to distinguish what exactly caused the plugin to trip (i.e., what mode it is in). 
     258 
     259There are numerous changes in this release.  I've re-done some of the code used to control the thermostat, standardizing the values used in the !OnMode, !OffMode, !HighTempMode, and !LowTempMode settings. 
     260 
     261Fixed a problem where the device was incorrectly defined.  It was urn:wdsc-hvac-org:device:WDSC_HVAC1, which is not correct for a Service.  It is now defined as urn:wdsc-hvac-org:serviceId:WDSC_HVAC1, so all calls to the plugin need to be updated to reflect this change. 
     262 
     263Direct Twilio support was removed from this version as well.  To use Twilio to send notifications, you will have to setup a trigger and then use LUUP to send the notification.