Add description to the overwrite and read blocks

GuowenLi-PhD · Jun 19, 2023 · 20f96a9 · 20f96a9
1 parent fb507ad
commit 20f96a9
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 17 deletions.
diff --git a/...ffice_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/BuildingControlEmulator.mo b/...ffice_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/BuildingControlEmulator.mo
@@ -1734,7 +1734,8 @@ package BuildingControlEmulator
           Modelica.Blocks.Interfaces.RealInput Tout
             "Connector of measurement input signal"
             annotation (Placement(transformation(extent={{-140,-80},{-100,-40}})));
-          Buildings.Utilities.IO.SignalExchange.Overwrite oveEcoDam
+          Buildings.Utilities.IO.SignalExchange.Overwrite oveEcoDam(description
+              ="AHU economizer damper position")
             annotation (Placement(transformation(extent={{-62,-6},{-48,8}})));
         equation
           connect(mixBox.port_Exh, port_Exh) annotation (Line(
@@ -2987,19 +2988,26 @@ package BuildingControlEmulator
               annotation (Placement(transformation(extent={{-26,10},{-6,30}})));
             Modelica.Blocks.Math.Add add(k2=-1)
               annotation (Placement(transformation(extent={{-56,10},{-36,30}})));
-            Buildings.Utilities.IO.SignalExchange.Overwrite oveTCooSet
+            Buildings.Utilities.IO.SignalExchange.Overwrite oveTCooSet(
+                description="Zone air cooling temperature setpoint")
               annotation (Placement(transformation(extent={{-80,50},{-60,70}})));
-            Buildings.Utilities.IO.SignalExchange.Overwrite oveTHeaSet
+            Buildings.Utilities.IO.SignalExchange.Overwrite oveTHeaSet(
+                description="Zone air heating temperature setpoint")
               annotation (Placement(transformation(extent={{-96,-64},{-88,-56}})));
-            Buildings.Utilities.IO.SignalExchange.Read TZon
+            Buildings.Utilities.IO.SignalExchange.Read TZon(description=
+                  "Zone air temperature", KPIs=Buildings.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.None)
               annotation (Placement(transformation(extent={{-92,-10},{-72,10}})));
-            Buildings.Utilities.IO.SignalExchange.Read TCooSet
+            Buildings.Utilities.IO.SignalExchange.Read TCooSet(description=
+                  "Zone air cooling temperature setpoint", KPIs=Buildings.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.None)
               annotation (Placement(transformation(extent={{-46,50},{-26,70}})));
-            Buildings.Utilities.IO.SignalExchange.Read THeaSet
+            Buildings.Utilities.IO.SignalExchange.Read THeaSet(description=
+                  "Zone air heating temperature setpoint", KPIs=Buildings.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.None)
               annotation (Placement(transformation(extent={{-80,-64},{-72,-56}})));
-            Buildings.Utilities.IO.SignalExchange.Overwrite oveAirFlowSetPoi
+            Buildings.Utilities.IO.SignalExchange.Overwrite oveAirFlowSetPoi(
+                description="Zone air flow rate setpoint")
               annotation (Placement(transformation(extent={{68,54},{82,68}})));
-            Buildings.Utilities.IO.SignalExchange.Overwrite oveyValPos
+            Buildings.Utilities.IO.SignalExchange.Overwrite oveyValPos(
+                description="Zone air terminal valve rate position")
               annotation (Placement(transformation(extent={{70,-66},{84,-52}})));
           equation
             connect(cooCon.y, swi.u1) annotation (Line(points={{11,60},{34,60},{34,28},{46,
@@ -4735,9 +4743,11 @@ First implementation.
             annotation (Placement(transformation(extent={{-140,-80},{-100,-40}})));
           Modelica.Blocks.Logical.Not not1
             annotation (Placement(transformation(extent={{-62,0},{-42,20}})));
-          Buildings.Utilities.IO.SignalExchange.Overwrite oveSpeSup
+          Buildings.Utilities.IO.SignalExchange.Overwrite oveSpeSup(description
+              ="AHU supply fan speed control signal")
             annotation (Placement(transformation(extent={{14,72},{30,88}})));
-          Buildings.Utilities.IO.SignalExchange.Overwrite ovePreSetPoi
+          Buildings.Utilities.IO.SignalExchange.Overwrite ovePreSetPoi(
+              description="AHU supply fan static pressure setpoint")
             annotation (Placement(transformation(extent={{-70,-88},{-54,-72}})));
           Buildings.Controls.OBC.CDL.Continuous.Switch swi
             annotation (Placement(transformation(extent={{12,28},{32,48}})));

diff --git a/..._complex_air/models/MultizoneOfficeComplexAir/BaseClasses/HVACSide/BaseClasses/AirSide.mo b/..._complex_air/models/MultizoneOfficeComplexAir/BaseClasses/HVACSide/BaseClasses/AirSide.mo
@@ -408,11 +408,11 @@ model AirSide "Air side system"
   Modelica.Blocks.Math.RealToBoolean reaToBooOcc
     "Convert real signal to boolean signal for occupancy signal"
     annotation (Placement(transformation(extent={{-60,90},{-40,110}})));
-  Buildings.Utilities.IO.SignalExchange.Overwrite oveFloor1TDisAir
+  Buildings.Utilities.IO.SignalExchange.Overwrite oveFloor1TDisAir(description="Floor 1 AHU supply air temperature setpoint")
     annotation (Placement(transformation(extent={{-40,46},{-20,66}})));
-  Buildings.Utilities.IO.SignalExchange.Overwrite oveFloor2TDisAir
+  Buildings.Utilities.IO.SignalExchange.Overwrite oveFloor2TDisAir(description="Floor 2 AHU supply air temperature setpoint")
     annotation (Placement(transformation(extent={{-40,46},{-20,66}})));
-  Buildings.Utilities.IO.SignalExchange.Overwrite oveFloor3TDisAir
+  Buildings.Utilities.IO.SignalExchange.Overwrite oveFloor3TDisAir(description="Floor 3 AHU supply air temperature setpoint")
     "AHU supply air temperature overwritten block"
     annotation (Placement(transformation(extent={{-40,46},{-20,66}})));
   Modelica.Blocks.Continuous.FirstOrder firOrd(T=1)
@@ -443,7 +443,7 @@ equation
           {108,22},{104,22},{104,66},{61,66}},        color={255,0,255}));
    for j in 1:5 loop
     connect(floor1.TZon[j], zonVAVCon[(1 - 1)*5 + j].T) annotation (Line(points={{166.5,
-            50},{166.5,42},{170,42},{170,90},{52,90},{52,100},{58,100}},
+            50},{180,50},{180,84},{50,84},{50,100},{58,100}},
           color={0,0,127}));
     connect(zonVAVCon[(1 - 1)*5 + j].yAirFlowSetPoi, floor1.AirFlowRatSetPoi[j])
       annotation (Line(points={{81.1,106.1},{100,106.1},{100,47},{111.5,47}},
@@ -527,6 +527,7 @@ equation
   connect(reaToBooOcc.y, booRep.u)
     annotation (Line(points={{-39,100},{-32,100}}, color={255,0,255}));
 
+
   annotation (Icon(coordinateSystem(preserveAspectRatio=false, extent={{-100,-100},
             {100,100}}),                                        graphics={
           Rectangle(

diff --git a/...ultizone_office_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/HVACSide/HVAC.mo b/...ultizone_office_complex_air/models/MultizoneOfficeComplexAir/BaseClasses/HVACSide/HVAC.mo
@@ -72,14 +72,18 @@ model HVAC
     "Entering air wet bulb temperature"
     annotation (Placement(transformation(extent={{-128,-82},{-100,-54}}),
         iconTransformation(extent={{-127,-83},{-100,-54}})));
-  Buildings.Utilities.IO.SignalExchange.Overwrite oveTCHWSet
+  Buildings.Utilities.IO.SignalExchange.Overwrite oveTCHWSet(description=
+        "Chilled water supply temperature setpoint")
     annotation (Placement(transformation(extent={{-40,-50},{-20,-30}})));
   Modelica.Blocks.Sources.RealExpression PHWPum(y=sum(boiWatPla.pumSecHW.P))
     "Hot water pump power consumption"
-    annotation (Placement(transformation(extent={{140,-66},{160,-46}})));
+    annotation (Placement(transformation(extent={{114,-74},{134,-54}})));
   Modelica.Blocks.Sources.RealExpression PBoi(y=boiWatPla.multiBoiler.boi[1].boi.QFue_flow
          + boiWatPla.multiBoiler.boi[2].boi.QFue_flow) "Boiler gas consumption"
-    annotation (Placement(transformation(extent={{110,-66},{130,-46}})));
+    annotation (Placement(transformation(extent={{114,-54},{134,-34}})));
+  Buildings.Utilities.IO.SignalExchange.Read read(description=
+        "Boiler gas consumption", KPIs=Buildings.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.GasPower)
+    annotation (Placement(transformation(extent={{152,-54},{172,-34}})));
 equation
   connect(chiWatNet.ports_a[1], floor1.port_b_CooWat) annotation (Line(
       points={{56,-91.1333},{88,-91.1333},{88,6},{124,6},{124,20}},
@@ -141,6 +145,8 @@ equation
   connect(oveTCHWSet.y, chiWatPla.TCHWSet) annotation (Line(points={{-19,-40},{-8,
           -40},{-8,-98},{-1.6,-98}}, color={0,0,127}));
 
+  connect(PBoi.y, read.u)
+    annotation (Line(points={{135,-44},{150,-44}}, color={0,0,127}));
   annotation (experiment(
       StartTime=17280000,
       StopTime=17452800,