From a415e4ebaf5921baa84ec43e71c7eb5a29329248 Mon Sep 17 00:00:00 2001
From: "Lu, Xing" <xing.lu@pnnl.gov>
Date: Tue, 30 Sep 2025 11:30:25 -0700
Subject: [PATCH 1/5] Add the actuator type to the read block

---
 IBPSA/Utilities/IO/SignalExchange/Read.mo     | 15 ++++-
 .../SignalTypes/SignalsForActuatorTravel.mo   | 61 +++++++++++++++++++
 .../SignalTypes/SignalsForKPIs.mo             |  4 +-
 .../SignalExchange/SignalTypes/package.order  |  1 +
 4 files changed, 79 insertions(+), 2 deletions(-)
 create mode 100644 IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForActuatorTravel.mo
diff --git a/IBPSA/Utilities/IO/SignalExchange/Read.mo b/IBPSA/Utilities/IO/SignalExchange/Read.mo
index f53b698bdf..22e9df77e1 100644
--- a/IBPSA/Utilities/IO/SignalExchange/Read.mo
+++ b/IBPSA/Utilities/IO/SignalExchange/Read.mo
@@ -23,6 +23,13 @@ model Read "Block that allows a signal to be read as an FMU output"
     KPIs==IBPSA.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.RelativeHumidity or
     KPIs==IBPSA.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.CO2Concentration)));
 
+  parameter SignalTypes.SignalsForActuatorTravel actuatorType = SignalTypes.SignalsForActuatorTravel.None if (
+  KPIs==IBPSA.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.ActuatorTravel)
+"Actuator type designation, required if KPIs is ActuatorTravel"
+  annotation(Dialog(enable=(
+    KPIs==IBPSA.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.ActuatorTravel)));
+
+protected
   final parameter Boolean boptestRead = true
     "Parameter that is used by tools to search for read block in models";
 
@@ -53,12 +60,18 @@ variable <code>y</code>, assign a type if needed for KPI
 calculation using the <code>KPIs</code> parameter, and assign a zone 
 designation using the <code>zone</code> parameter if the KPI calculation is
 specific to a particular zone (for multi-zone models). See documentation for 
-the parameter <code>zone</code> for more details.
+assign an actuator type designation using the <code>actuatorType</code> parameter.
+ See documentation for the parameter <code>actuatorType</code> for more details. 
 </p>
 </html>",
 revisions="<html>
 <ul>
 <li>
+September 30, 2025 by Xing Lu:<br/>
+Added actuator type designation for KPI calculation by parameter <code>actuatorType</code>.
+See <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/2060\">#2060</a>.
+</li>
+<li>
 February 17, 2022 by David Blum:<br/>
 Made parameter <code>boptestRead</code> unprotected.
 This is for <a href=\"https://github.com/ibpsa/modelica-ibpsa/issues/1585\">#1585</a>.
diff --git a/IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForActuatorTravel.mo b/IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForActuatorTravel.mo
new file mode 100644
index 0000000000..b5bdccaa27
--- /dev/null
+++ b/IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForActuatorTravel.mo
@@ -0,0 +1,61 @@
+within IBPSA.Utilities.IO.SignalExchange.SignalTypes;
+type SignalsForActuatorTravel = enumeration(
+    None
+      "Not used for control actuators",
+    Damper
+      "Damper",
+    Valve
+      "Valve",
+    Fan
+      "Fan",
+    Pump
+      "Pump",
+    HVACEquipment
+      "HVAC Equipment",
+    Other
+      "Other")
+  "Signals used for the calculation of key performance indexes"
+  annotation (Documentation(info="<html>
+<p>This enumeration defines the signal types that are used by BOPTEST to compute the actuator travel. </p>
+<p>The following signal types are supported. </p>
+<table cellspacing=\"0\" cellpadding=\"2\" border=\"1\"><tr>
+<td><p align=\"center\"><h4>Value</h4></p></td>
+<td><p align=\"center\"><h4>Description</h4></p></td>
+</tr>
+<tr>
+<td><p><span style=\"font-family: Courier New;\">None</span></p></td>
+<td><p>Not used for actuator travel</p></td>
+</tr>
+<tr>
+<td><p><span style=\"font-family: Courier New;\">Damper</span></p></td>
+<td><p>Damper signal (e.g., damper openess signal)</p></td>
+</tr>
+<tr>
+<td><p><span style=\"font-family: Courier New;\">Valve</span></p></td>
+<td><p>Valve signal (e.g., valve openess signal)</p></td>
+</tr>
+<tr>
+<td><p><span style=\"font-family: Courier New;\">Fan</span></p></td>
+<td><p>Fan signal (e.g., fan speed signal)</p></td>
+</tr>
+<tr>
+<td><p><span style=\"font-family: Courier New;\">Pump</span></p></td>
+<td><p>Pump signal (e.g., pump speed signal)</p></td>
+</tr>
+<tr>
+<td><p><span style=\"font-family: Courier New;\">HVACEquipment</span></p></td>
+<td><p>HVAC equipment signal (e.g., heat pump signal)</p></td>
+</tr>
+<tr>
+<td><p><span style=\"font-family: Courier New;\">Other</span></p></td>
+<td><p>Other actuator signal</p></td>
+</tr>
+</table>
+</html>", revisions="<html>
+<ul>
+<li>
+September 30, 2025, by Xing Lu:<br/>
+First implementation.
+</li>
+</ul>
+</html>"));
diff --git a/IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForKPIs.mo b/IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForKPIs.mo
index 3f7a8d99ca..f19d216f91 100644
--- a/IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForKPIs.mo
+++ b/IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForKPIs.mo
@@ -23,7 +23,9 @@ type SignalsForKPIs = enumeration(
     SolarThermalPower
       "Thermal power from solar thermal",
     FreshWaterFlowRate
-      "FreshWaterFlowRate") "Signals used for the calculation of key performance indicators"
+      "FreshWaterFlowRate",
+    ActuatorTravel
+      "Actuator travel") "Signals used for the calculation of key performance indicators"
   annotation (Documentation(info="<html>
 <p>
 This enumeration defines the signal types that are used by BOPTEST
diff --git a/IBPSA/Utilities/IO/SignalExchange/SignalTypes/package.order b/IBPSA/Utilities/IO/SignalExchange/SignalTypes/package.order
index 8da74d2531..97da893565 100644
--- a/IBPSA/Utilities/IO/SignalExchange/SignalTypes/package.order
+++ b/IBPSA/Utilities/IO/SignalExchange/SignalTypes/package.order
@@ -1 +1,2 @@
 SignalsForKPIs
+SignalsForActuatorTravel

From 5c68288cfc5a7c799d792888250cb47c49935341 Mon Sep 17 00:00:00 2001
From: "Lu, Xing" <xing.lu@pnnl.gov>
Date: Tue, 30 Sep 2025 11:30:57 -0700
Subject: [PATCH 2/5] Update Read.mo

---
 IBPSA/Utilities/IO/SignalExchange/Read.mo | 1 +
 1 file changed, 1 insertion(+)

diff --git a/IBPSA/Utilities/IO/SignalExchange/Read.mo b/IBPSA/Utilities/IO/SignalExchange/Read.mo
index 22e9df77e1..99fe4ef55d 100644
--- a/IBPSA/Utilities/IO/SignalExchange/Read.mo
+++ b/IBPSA/Utilities/IO/SignalExchange/Read.mo
@@ -60,6 +60,7 @@ variable <code>y</code>, assign a type if needed for KPI
 calculation using the <code>KPIs</code> parameter, and assign a zone 
 designation using the <code>zone</code> parameter if the KPI calculation is
 specific to a particular zone (for multi-zone models). See documentation for 
+the parameter <code>zone</code> for more details. If the KPI type is for actuator travel,
 assign an actuator type designation using the <code>actuatorType</code> parameter.
  See documentation for the parameter <code>actuatorType</code> for more details. 
 </p>

From 0d22adbf042b8c3c5fb7b5219a44d25b9704ea27 Mon Sep 17 00:00:00 2001
From: "Lu, Xing" <xing.lu@pnnl.gov>
Date: Tue, 30 Sep 2025 11:52:30 -0700
Subject: [PATCH 3/5] Change the documentation

---
 IBPSA/Utilities/IO/SignalExchange/Read.mo                   | 6 +++---
 .../SignalExchange/SignalTypes/SignalsForActuatorTravel.mo  | 2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/IBPSA/Utilities/IO/SignalExchange/Read.mo b/IBPSA/Utilities/IO/SignalExchange/Read.mo
index 99fe4ef55d..482b9aedf1 100644
--- a/IBPSA/Utilities/IO/SignalExchange/Read.mo
+++ b/IBPSA/Utilities/IO/SignalExchange/Read.mo
@@ -29,7 +29,6 @@ model Read "Block that allows a signal to be read as an FMU output"
   annotation(Dialog(enable=(
     KPIs==IBPSA.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.ActuatorTravel)));
 
-protected
   final parameter Boolean boptestRead = true
     "Parameter that is used by tools to search for read block in models";
 
@@ -60,9 +59,10 @@ variable <code>y</code>, assign a type if needed for KPI
 calculation using the <code>KPIs</code> parameter, and assign a zone 
 designation using the <code>zone</code> parameter if the KPI calculation is
 specific to a particular zone (for multi-zone models). See documentation for 
-the parameter <code>zone</code> for more details. If the KPI type is for actuator travel,
+the parameter <code>zone</code> for more details. 
+If the KPI type is for actuator travel,
 assign an actuator type designation using the <code>actuatorType</code> parameter.
- See documentation for the parameter <code>actuatorType</code> for more details. 
+See documentation for the parameter <code>actuatorType</code> for more details. 
 </p>
 </html>",
 revisions="<html>
diff --git a/IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForActuatorTravel.mo b/IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForActuatorTravel.mo
index b5bdccaa27..78d00e8c1c 100644
--- a/IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForActuatorTravel.mo
+++ b/IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForActuatorTravel.mo
@@ -16,7 +16,7 @@ type SignalsForActuatorTravel = enumeration(
       "Other")
   "Signals used for the calculation of key performance indexes"
   annotation (Documentation(info="<html>
-<p>This enumeration defines the signal types that are used by BOPTEST to compute the actuator travel. </p>
+<p>This enumeration defines the actuator signal types that are used by BOPTEST to compute the actuator travel. </p>
 <p>The following signal types are supported. </p>
 <table cellspacing=\"0\" cellpadding=\"2\" border=\"1\"><tr>
 <td><p align=\"center\"><h4>Value</h4></p></td>

From 5b029b186ce820dc2ce3651254700ffeb42b9bf1 Mon Sep 17 00:00:00 2001
From: "Lu, Xing" <xing.lu@pnnl.gov>
Date: Tue, 30 Sep 2025 11:54:44 -0700
Subject: [PATCH 4/5] Update Read.mo

---
 IBPSA/Utilities/IO/SignalExchange/Read.mo | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/IBPSA/Utilities/IO/SignalExchange/Read.mo b/IBPSA/Utilities/IO/SignalExchange/Read.mo
index 482b9aedf1..e1fb880a23 100644
--- a/IBPSA/Utilities/IO/SignalExchange/Read.mo
+++ b/IBPSA/Utilities/IO/SignalExchange/Read.mo
@@ -24,8 +24,8 @@ model Read "Block that allows a signal to be read as an FMU output"
     KPIs==IBPSA.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.CO2Concentration)));
 
   parameter SignalTypes.SignalsForActuatorTravel actuatorType = SignalTypes.SignalsForActuatorTravel.None if (
-  KPIs==IBPSA.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.ActuatorTravel)
-"Actuator type designation, required if KPIs is ActuatorTravel"
+    KPIs==IBPSA.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.ActuatorTravel)
+    "Actuator type designation, required if KPIs is ActuatorTravel"
   annotation(Dialog(enable=(
     KPIs==IBPSA.Utilities.IO.SignalExchange.SignalTypes.SignalsForKPIs.ActuatorTravel)));
 

From 9de53743982cb1ff4906ae1b87a64f1886dfb33f Mon Sep 17 00:00:00 2001
From: "Lu, Xing" <xing.lu@pnnl.gov>
Date: Tue, 30 Sep 2025 12:10:05 -0700
Subject: [PATCH 5/5] Update SignalsForActuatorTravel.mo

---
 .../IO/SignalExchange/SignalTypes/SignalsForActuatorTravel.mo   | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForActuatorTravel.mo b/IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForActuatorTravel.mo
index 78d00e8c1c..581ea7fca6 100644
--- a/IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForActuatorTravel.mo
+++ b/IBPSA/Utilities/IO/SignalExchange/SignalTypes/SignalsForActuatorTravel.mo
@@ -14,7 +14,7 @@ type SignalsForActuatorTravel = enumeration(
       "HVAC Equipment",
     Other
       "Other")
-  "Signals used for the calculation of key performance indexes"
+  "Signals used for the calculation of the actuator travel"
   annotation (Documentation(info="<html>
 <p>This enumeration defines the actuator signal types that are used by BOPTEST to compute the actuator travel. </p>
 <p>The following signal types are supported. </p>

Value	Description
None	Not used for actuator travel
Damper	Damper signal (e.g., damper openess signal)
Valve	Valve signal (e.g., valve openess signal)
Fan	Fan signal (e.g., fan speed signal)
Pump	Pump signal (e.g., pump speed signal)
HVACEquipment	HVAC equipment signal (e.g., heat pump signal)
Other	Other actuator signal