fix dehumidification bug

Author: cvogt729

README.md

@@ -25,7 +25,7 @@ Refer to the [Commissioning Scripts](https://github.com/automatic-controls/commi
 - **Airflow Damper** - Creates and analyzes a graph of airflow (*cfm*) vs damper position (*%*). Intended for use with dampers controlled by an airflow microblock (e.g, the integrated dampers on [ZN141A](https://www.automatedlogic.com/en/products/webctrl-building-automation-system/building-controllers/zn141a/), [ZN341A](https://www.automatedlogic.com/en/products/webctrl-building-automation-system/building-controllers/zn341a/), [OF141-E2](https://www.automatedlogic.com/en/products/webctrl-building-automation-system/building-controllers/OF141-E2/), and [OF342-E2](https://www.automatedlogic.com/en/products/webctrl-building-automation-system/building-controllers/OF342-E2/). When heating/cooling elements are tested, the airflow setpoint is set to the heating/cooling maximum.
 - **Fans** - Performs start/stop tests on any number of fans. Requires a binary/analog output to command each fan on or off. Optionally may include a second output which controls VFD speed. The script expects a binary input for monitoring fan status. When testing airflow dampers and heating/cooling elements, all fans are commanded on to ensure adequate airflow.
 - **Heating / Cooling Elements** - Creates and analyzes a graph of temperature (*°F*) vs time (*minutes*). Requires an output for turning each element on/off. Also requires a leaving air temperature sensor, but an entering air temperature sensor is optional. An optional status input and reversing output may be included. The reversing output control is designed to switch the mode of an element from heating to cooling or vice versa.
-- **Dehumidification** - Creates and analyzes a graph of humidity (*%*) vs time (*minutes*). Requires a binary/analog output for commanding dehumidification to turn on/off. Temperature is also monitored for the duration of this test to verify that dehumidification mode does not significantly alter temperature.
+- **Dehumidification** - Creates and analyzes a graph of humidity (*%*) vs time (*minutes*). Requires a binary/analog output for commanding dehumidification to turn on/off. A binary input is optional for monitoring status. Temperature is also monitored for the duration of this test to verify that dehumidification mode does not significantly alter temperature.
 - **OA / RA Dampers** - For the duration of all tests, the OA damper is fully closed, and the RA damper is fully opened. In the future, I may implement logic to test economizing capabilities of OA / RA dampers.
 
 If your control program does not match these specifications exactly, there are workarounds which can be implemented in the logic. For example, if a supply fan uses an analog input to monitor status by measuing amp draw, then you could throw an *BACnet Binary Value Status* microblock into the logic which turns on when the amp draw is above a certain threshold. Then you would map the status tag to this microblock instead.
@@ -108,8 +108,9 @@ For mapping multiple *on* and *off* points, occurences of `#` should be replaced
 | `dehum_lock_min` | `dehum/min_pres_value` | Minimum DEHU lock value |
 | `dehum_lock_max` | `dehum/max_pres_value` | Maximum DEHU lock value |
 | `dehum_fault` | `dehum/status_flags/fault` | Whether DEHU has a fault |
+| `dehum_status` | `dehum_status/present_value` | Whether the DEHU component has status |
 
-These mappings are meant to control a single analog/binary output. Before testing dehumidification mode, all elements with a reversing command are switched to cooling mode. It is expected that locking this output on is sufficient to simulate/trigger dehumidification mode. The `dehum_lock_flag` and `dehum_lock_value` tags are required, but the others are optional.
+These mappings are meant to control a single analog/binary output. Before testing dehumidification mode, all elements with a reversing command are switched to cooling mode. It is expected that locking this output on is sufficient to simulate/trigger dehumidification mode. The `dehum_lock_flag` and `dehum_lock_value` tags are required, but the others are optional. `dehum_status` might be mapped to a particular compressor's status in a heat pump, for example.
 
 ### Airflow Dampers
 | Semantic Tag | Sample Expression | Description |

resources/tags_generic.json

@@ -22,6 +22,7 @@
   "dehum_lock_min": "dehum/min_pres_value",
   "dehum_lock_max": "dehum/max_pres_value",
   "dehum_fault": "dehum/status_flags/fault",
+  "dehum_status":"dehum_status/present_value",
 
   "off#_lock_flag": "off#/locked",
   "off#_lock_value": "off#/locked_value",

src/aces/webctrl/scripts/terminalunits/Data.java

@@ -21,13 +21,16 @@ public class Data implements Comparable<Data> {
   private volatile PrimaryTemp temp;
   private volatile Humidity hum;
   private volatile Output dehum;
+  private volatile BinaryInput dehumStatus;
   private volatile OATemp oat;
   private volatile OADamper oad;
   private volatile Airflow air;
   private volatile Fan fans[];
   private volatile boolean hasFans = false;
   private volatile Element elements[];
   private volatile int numElements = 0;
+  private volatile boolean dehumStartTest = false;
+  private volatile boolean dehumStopTest = false;
   private volatile boolean alarmTriggered = false;
   private volatile boolean lossOfAirflow = false;
   private volatile Trend tempTrend = null;
@@ -49,13 +52,15 @@ public Data(ResolvedTestingUnit x, Params p) throws Throwable {
       temp = new PrimaryTemp(this);
       hum = new Humidity(this);
       dehum = new Output(this, "dehum");
+      dehumStatus = new BinaryInput(this, "dehum_status");
       oat = new OATemp(this);
       oad = new OADamper(this);
       air = new Airflow(this);
       if (!alarm.isDefined()){ alarm = null; }
       if (!temp.isDefined()){ temp = null; }
       if (!hum.isDefined()){ hum = null; }
       if (!dehum.isDefined()){ dehum = null; }
+      if (!dehumStatus.isDefined()){ dehumStatus = null; }
       if (!oat.isDefined()){ oat = null; }
       if (!oad.isDefined()){ oad = null; }
       if (!air.isDefined()){ air = null; }
@@ -451,8 +456,12 @@ public int compare(Element a, Element b){
             if ((t=hum.get(5, 2000))==null){
               break testing;
             }
+            if (dehumStatus!=null && !dehumStatus.get(true)){
+              dehumStopTest = true;
+            }
             if (dehum.set(true)){
               humTrend = new Trend(64);
+              humTrend.offset = 45;
               humTrend.add(t);
               while (true){
                 Thread.sleep(10000L);
@@ -478,6 +487,9 @@ public int compare(Element a, Element b){
                   seg.highDanger = temp.highLimitPass;
                   break;
                 }
+                if (dehumStatus!=null && !dehumStartTest && !dehumStatus.hasFault() && dehumStatus.get(false)){
+                  dehumStartTest = true;
+                }
               }
             }
           }
@@ -501,6 +513,9 @@ public int compare(Element a, Element b){
       }
       if (dehum!=null){
         sb.append("<br>Dehumidification&nbsp;Command");
+        if (dehumStatus!=null){
+          sb.append("&nbsp;+&nbsp;Status");
+        }
       }
       if (oad!=null){
         sb.append("<br>Outdoor&nbsp;Air&nbsp;Damper");
@@ -600,6 +615,7 @@ public void print(final StringBuilder sb, final boolean JSON){
     prefix|=addProblem(sb, temp, "Primary Temperature Sensor", prefix);
     prefix|=addProblem(sb, hum, "Humidity Sensor", prefix);
     prefix|=addProblem(sb, dehum, "Dehumidification Command", prefix);
+    prefix|=addProblem(sb, dehumStatus, "Dehumidification Status", prefix);
     prefix|=addProblem(sb, oat, "OAT Sensor", prefix);
     prefix|=addProblem(sb, oad, "OAD Command", prefix);
     prefix|=addProblem(sb, air, "Airflow Microblock", prefix);
@@ -620,6 +636,7 @@ public void print(final StringBuilder sb, final boolean JSON){
     prefix|=addFault(sb, temp, "Primary Temperature Sensor", prefix);
     prefix|=addFault(sb, hum, "Humidity Sensor", prefix);
     prefix|=addFault(sb, dehum, "Dehumidification Command", prefix);
+    prefix|=addFault(sb, dehumStatus, "Dehumidification Status", prefix);
     prefix|=addFault(sb, oat, "OAT Sensor", prefix);
     prefix|=addFault(sb, oad, "OAD Command", prefix);
     prefix|=addFault(sb, air, "Airflow Microblock", prefix);
@@ -717,6 +734,16 @@ public void print(final StringBuilder sb, final boolean JSON){
     }
     sb.append(",\n\"commandTests\":[\n");
     prefix = false;
+    if (humTrend!=null && dehumStatus!=null){
+      if (prefix){
+        sb.append(",\n");
+      }else{
+        prefix = true;
+      }
+      sb.append("{\n\"name\":\"Dehum\",\n");
+      sb.append("\"start\":").append(dehumStartTest).append(",\n");
+      sb.append("\"stop\":").append(dehumStopTest).append("\n}");
+    }
     if (hasFans && p.ctrlFans){
       for (i=0;i<fans.length;++i){
         if (fans[i]!=null && fans[i].status().isDefined()){

src/aces/webctrl/scripts/terminalunits/Output.html

@@ -393,7 +393,7 @@
                       let xPrev = 0;
                       let yPrev = 0;
                       for (const z of trend){
-                        addTest("Dehumidification", !z["increasing"] && z["max"]-z["min"]>=Number(humMargin.value));
+                        addTest("Dehumidification", !z["increasing"] && z["max"]-z["min"]>=Number(humMargin.value), tdGeneralTests);
                         const xData = z["x"];
                         const yData = z["y"];
                         for (var i = 0; i < yData.length; ++i) {
@@ -411,7 +411,7 @@
                     }
                     addTest("Erratic Humidistat", success, tdGeneralTests);
                     const tHum = y["tempTrend"][y["tempTrend"].length-1];
-                    addTest("Dehumidification Temperature Constant", tHum["max"]-tHum["min"]<Number(humTMargin.value));
+                    addTest("Dehumidification Temperature Constant", tHum["max"]-tHum["min"]<Number(humTMargin.value), tdGeneralTests);
                   }
                 }
               };

src/aces/webctrl/scripts/terminalunits/TerminalUnitTest.java

@@ -12,7 +12,7 @@ public class TerminalUnitTest extends Script {
   private volatile String outputString = null;
   private volatile Params p = null;
   @Override public String getDescription(){
-    return "<a href=\"https://github.com/automatic-controls/commissioning-scripts/tree/main/samples/TerminalUnitTest\" target=\"_blank\" style=\"border:none;\">Terminal Unit Commissioning Script</a> v0.2.0<br>Evaluates performance of fans, dampers, heating, cooling, and dehumidification components.";
+    return "<a href=\"https://github.com/automatic-controls/commissioning-scripts/tree/main/samples/TerminalUnitTest\" target=\"_blank\" style=\"border:none;\">Terminal Unit Commissioning Script</a> v0.2.1<br>Evaluates performance of fans, dampers, heating, cooling, and dehumidification components.";
   }
   @Override public String[] getParamNames(){
     return new String[]{"Dampers", "Fans", "Heating / Cooling"};

src/aces/webctrl/scripts/terminalunits/Trend.java

@@ -8,6 +8,7 @@ public class Trend {
   public volatile double OFFSET_FACTOR = 0.018;
   public volatile int TRAILING_AVG = 5;
   public volatile int MIDDLE_AVG = 10;
+  public volatile int offset = 15;
   public volatile long[] x;
   public volatile double[] y;
   public volatile int len = 0;
@@ -91,7 +92,7 @@ public boolean isIncreasing(){
    * @return whether this trend appears to have stabalized.
    */
   public boolean hasStabilized(){
-    if (len<start+MIDDLE_AVG+TRAILING_AVG+15){
+    if (len<start+MIDDLE_AVG+TRAILING_AVG+offset){
       return false;
     }
     int i;