From 0b4e56c04f5a97e56ad78e7d36233e4e6675fe34 Mon Sep 17 00:00:00 2001 From: Claire Stirdivant Date: Thu, 2 May 2024 16:59:58 +0000 Subject: [PATCH 1/2] elevate PMP and VLV to the global namespace --- .../HVAC/entity_types/GENERALTYPES.yaml | 18 ------- .../yaml/resources/HVAC/entity_types/PMP.yaml | 49 +++++------------ .../yaml/resources/HVAC/entity_types/VLV.yaml | 22 ++++---- .../PLUMBING/entity_types/GENERALTYPES.yaml | 23 -------- .../resources/PLUMBING/entity_types/PMP.yaml | 2 +- .../resources/PLUMBING/entity_types/TK.yaml | 2 +- .../resources/PLUMBING/entity_types/VLV.yaml | 4 +- .../yaml/resources/entity_types/global.yaml | 53 +++++++++++++------ 8 files changed, 66 insertions(+), 107 deletions(-) diff --git a/ontology/yaml/resources/HVAC/entity_types/GENERALTYPES.yaml b/ontology/yaml/resources/HVAC/entity_types/GENERALTYPES.yaml index 0bdb44043e..3f93ae152e 100644 --- a/ontology/yaml/resources/HVAC/entity_types/GENERALTYPES.yaml +++ b/ontology/yaml/resources/HVAC/entity_types/GENERALTYPES.yaml @@ -74,15 +74,6 @@ HX: implements: - EQUIPMENT -PMP: - guid: "0984adbd-943c-4bf8-9b4e-af51c24c2736" - description: "Tag for pumps. Pumps move liquid (water, glycol, liquid CO2, etc.) from one part of a system to another." - is_abstract: true - opt_uses: - - failed_communication_alarm - implements: - - EQUIPMENT - FRZ: guid: "98018a25-3cbc-4cc6-8405-527215394a2c" description: "Tag for freezers." @@ -280,15 +271,6 @@ HUM: implements: - EQUIPMENT -VLV: - guid: "3b576a44-4ab8-4e9b-ad8f-65f1b9f08238" - description: "Tag for valves. Valves are devices which control the flow of water." - is_abstract: true - opt_uses: - - failed_communication_alarm - implements: - - EQUIPMENT - RSR: guid: "95d5ac12-326d-45d3-94f2-0fac854af027" description: "A generic distribution riser." diff --git a/ontology/yaml/resources/HVAC/entity_types/PMP.yaml b/ontology/yaml/resources/HVAC/entity_types/PMP.yaml index efebe51cde..e042076c91 100644 --- a/ontology/yaml/resources/HVAC/entity_types/PMP.yaml +++ b/ontology/yaml/resources/HVAC/entity_types/PMP.yaml @@ -21,7 +21,7 @@ PMP_SS: description: "Typical pump." is_canonical: true implements: - - PMP + - /PMP # inherits from global namespace - SS PMP_SS_VSC: @@ -29,7 +29,7 @@ PMP_SS_VSC: description: "Typical variable speed pump." is_canonical: true implements: - - PMP + - /PMP # inherits from global namespace - SS - VSC @@ -38,7 +38,7 @@ PMP_DRPM: description: "Pump implemented with drain pump monitoring ." is_canonical: true implements: - - PMP + - /PMP # inherits from global namespace - DRPM PMP_SS_VSC_WDPM: @@ -46,7 +46,7 @@ PMP_SS_VSC_WDPM: description: "Variable speed pump with differential pressure monitoring." is_canonical: true implements: - - PMP + - /PMP # inherits from global namespace - SS - VSC - WDPM @@ -56,7 +56,7 @@ PMP_SS_VSC_WDPC: description: "Pump with variable speed control and differential pressure control" is_canonical: true implements: - - PMP + - /PMP # inherits from global namespace - SS - VSC - WDPC @@ -66,7 +66,7 @@ PMP_SS_VSFC: description: "PMP device with pump frequency control" is_canonical: true implements: - - PMP + - /PMP # inherits from global namespace - SS - VSFC opt_uses: @@ -81,7 +81,7 @@ PMP_SS_CHWISOVPM_VSFC: description: "PMP device with chilled water valve and pump frequency control" is_canonical: true implements: - - PMP + - /PMP # inherits from global namespace - SS - CHWISOVPM - VSFC @@ -97,7 +97,7 @@ PMP_SS_VSC_WDPC_WFRC: description: "Pump with variable speed control, differential pressure control and flow control." is_canonical: true implements: - - PMP + - /PMP # inherits from global namespace - SS - VSC - WDPC @@ -108,7 +108,7 @@ PMP_SS_VSC_SWTC: description: "Pump with variable speed control and supply water temperature control" is_canonical: true implements: - - PMP + - /PMP # inherits from global namespace - SS - VSC - SWTC @@ -118,7 +118,7 @@ PMP_SS_CWCS_VSFC: description: "PMP device with condensing water valve and pump frequency control" is_canonical: true implements: - - PMP + - /PMP # inherits from global namespace - SS - CWCS - VSFC @@ -132,7 +132,7 @@ PMP_SS_RMM: description: "Pump with pressure switch and failed alarm monitoring" is_canonical: true implements: - - PMP + - /PMP # inherits from global namespace - SS - RMM opt_uses: @@ -145,7 +145,7 @@ PMP_SS_WDPM: description: "Pump with pressure alarms and status monitoring" is_canonical: true implements: - - PMP + - /PMP # inherits from global namespace - SS - WDPM @@ -154,30 +154,7 @@ PMP_SS_VSC_HWBYPVM: description: "Variable speed pump with heating water bypass valve binary control." is_canonical: true implements: - - PMP + - /PMP # inherits from global namespace - SS - VSC - HWBYPVM - -################################### -### Existing Non-standard Types ### -################################### - -PMP_SS_VSC_NONCANONICAL_1: - guid: "026231f9-fae5-4250-8d4b-c8b33948dc5d" - description: "Non-standard variable speed pump." - implements: - - PMP_SS_VSC - - INCOMPLETE - uses: - - speed_frequency_command - -PMP_SS_VSC_NONCANONICAL_2: - guid: "f9ffc542-75a0-4159-9b19-2b72fd1b4396" - description: "One-off pump that performs chilled water blending." - implements: - - PMP_SS_VSC - uses: - - mixing_valve_percentage_command - - chilled_supply_water_temperature_setpoint - - chilled_supply_water_temperature_sensor diff --git a/ontology/yaml/resources/HVAC/entity_types/VLV.yaml b/ontology/yaml/resources/HVAC/entity_types/VLV.yaml index 25173287f7..1782942251 100644 --- a/ontology/yaml/resources/HVAC/entity_types/VLV.yaml +++ b/ontology/yaml/resources/HVAC/entity_types/VLV.yaml @@ -16,12 +16,12 @@ ### Canonical Types ### ######################## -VLV_CHWVM_RTM_DTM: +VLV_CHWVM_RTM_DTM: # TODO: remodel this, it is redudant to implement an abstract with `valve` fields guid: "b2223a12-07e8-455b-8ae4-eed3942df5a8" description: "Chilled water valve with discharge and return temperature monitoring." is_canonical: true implements: - - VLV + - /VLV # inherits from global namespace - CHWVM - RTM - DTM @@ -31,37 +31,37 @@ VLV_HWVM: # If we want to keep this, should match CHW valve (i.e. add RTM and DT description: "Heating water valve." is_canonical: true implements: - - VLV + - /VLV # inherits from global namespace - HWVM -VLV_CHWPVM: +VLV_CHWPVM: # TODO: remodel this, it is redudant to implement an abstract with `valve` fields guid: "4222857f-3f92-4663-83ac-0bb11550f568" description: "Chilled water pressure control valve." is_canonical: true implements: - - VLV + - /VLV # inherits from global namespace - CHWPVM -VLV_HWPVM: +VLV_HWPVM: # TODO: remodel this, it is redudant to implement an abstract with `valve` fields guid: "8ead3ca8-7f64-421c-9293-fcbf440bcc4f" description: "Heating water pressure control valve." is_canonical: true implements: - - VLV + - /VLV # inherits from global namespace - HWPVM -VLV_CDWPVM: +VLV_CDWPVM: # TODO: remodel this, it is redudant to implement an abstract with `valve` fields guid: "f656bec8-3061-4e60-b7d2-00f754bad5af" description: "Condensing water pressure control valve." is_canonical: true implements: - - VLV + - /VLV # inherits from global namespace - CDWPVM -VLV_SWCM: +VLV_SWCM: # TODO: remodel this, it is redudant to implement an abstract with `valve` fields guid: "e0552cad-7620-462c-9571-b832cda303f5" description: "Solenoid water valve control and monitoring." is_canonical: true implements: - - VLV + - /VLV # inherits from global namespace - SWCM diff --git a/ontology/yaml/resources/PLUMBING/entity_types/GENERALTYPES.yaml b/ontology/yaml/resources/PLUMBING/entity_types/GENERALTYPES.yaml index 55ed6f1616..4d7bcdc784 100644 --- a/ontology/yaml/resources/PLUMBING/entity_types/GENERALTYPES.yaml +++ b/ontology/yaml/resources/PLUMBING/entity_types/GENERALTYPES.yaml @@ -12,12 +12,6 @@ # See the License for the specific language governing permissions and # limitations under the License. -TK: - guid: "26a8e189-fba3-4b4c-8df1-9e3bd638547f" - description: "Tank water system used to store water" - is_abstract: true - implements: - - EQUIPMENT WSTC: guid: "743edd10-ec99-42fd-b2e2-00357ab89c01" @@ -25,14 +19,6 @@ WSTC: is_abstract: true implements: - EQUIPMENT - -PMP: - guid: "e299dffb-f686-47f8-9a0a-6ed48c116e72" - description: "Pumps move liquid (e.g., water, glycol, liquid CO2) from one part of a system - to another. In this namespace, pumps are used for irrigation and domestic purposes." - is_abstract: true - implements: - - EQUIPMENT RO: guid: "9f9b8144-df6c-4b20-bbbb-110f718c1cb1" @@ -41,15 +27,6 @@ RO: implements: - EQUIPMENT -VLV: - guid: "396ab9cc-500d-4e0a-b09c-be249cb3e420" - description: "Tag for valves. Valves are devices which control the flow of water. " - is_abstract: true - opt_uses: - - failed_communication_alarm - implements: - - EQUIPMENT - WSR: guid: "178274c8-ec3d-4c5a-b2f3-f5ae7cb894dc" description: "Water softener" diff --git a/ontology/yaml/resources/PLUMBING/entity_types/PMP.yaml b/ontology/yaml/resources/PLUMBING/entity_types/PMP.yaml index 5d5bdf4337..4a973b86b6 100644 --- a/ontology/yaml/resources/PLUMBING/entity_types/PMP.yaml +++ b/ontology/yaml/resources/PLUMBING/entity_types/PMP.yaml @@ -23,7 +23,7 @@ PMP_SS: description: "Basic water pump." is_canonical: true implements: - - PMP + - /PMP # inherits from global namespace - SS diff --git a/ontology/yaml/resources/PLUMBING/entity_types/TK.yaml b/ontology/yaml/resources/PLUMBING/entity_types/TK.yaml index 7eadba7ba4..e83d34a580 100644 --- a/ontology/yaml/resources/PLUMBING/entity_types/TK.yaml +++ b/ontology/yaml/resources/PLUMBING/entity_types/TK.yaml @@ -23,5 +23,5 @@ TK_LVLM: description: "Standard tank with level monitoring." is_canonical: true implements: - - TK #TODO: make this inherit from the GLOBAL namespace + - /TK # inherits from global namespace - LVLM diff --git a/ontology/yaml/resources/PLUMBING/entity_types/VLV.yaml b/ontology/yaml/resources/PLUMBING/entity_types/VLV.yaml index f4db9cd2ca..df67f79165 100644 --- a/ontology/yaml/resources/PLUMBING/entity_types/VLV.yaml +++ b/ontology/yaml/resources/PLUMBING/entity_types/VLV.yaml @@ -16,10 +16,10 @@ ### Canonical Types ### ######################## -VLV_WVCM: +VLV_WVCM: # TODO: remodel this, it is redudant to implement an abstract with `valve` fields guid: "63e9ccb7-67f6-4547-aff8-d3cf30d1ab40" description: "Solenoid water valve control and monitoring." is_canonical: true implements: - - VLV + - /VLV # inherits from global namespace - WVCM diff --git a/ontology/yaml/resources/entity_types/global.yaml b/ontology/yaml/resources/entity_types/global.yaml index 12c02be81a..ade3565c1e 100644 --- a/ontology/yaml/resources/entity_types/global.yaml +++ b/ontology/yaml/resources/entity_types/global.yaml @@ -20,20 +20,6 @@ EQUIPMENT: - manufacturer_label - model_label -SENSOR: - guid: "4fa42531-26a8-4d1f-a0b3-a7f6bb5623e1" - description: "Stand-alone sensing device. Used to model individual sensors when they don't belong explicitly to one piece of equipment." - is_abstract: true - implements: - - EQUIPMENT - -USER_INTERFACE: - guid: "ec863942-5bda-4f44-b6ab-af80e72a0f2e" - description: "Generic user interface." - is_abstract: true - implements: - - EQUIPMENT - NO_ANALYSIS: guid: "42a7614d-e6c9-4cec-96fb-de868b3985c2" description: "Devices which are not useful in and of themselves. Can be ignored by analysis." @@ -54,10 +40,47 @@ INCOMPLETE: description: "A known incomplete type." is_abstract: true -##Global namespace for tanks## +## Global namespace definition for certain general types ## +############################################################## +#### GENERAL TYPES (BROAD CATEGORIES OF COMMON EQUIPMENT) #### +#### See model.md for context #### +############################################################## + +PMP: + guid: "0984adbd-943c-4bf8-9b4e-af51c24c2736" + description: "Tag for pumps. Pumps move liquid (water, glycol, liquid CO2, etc.) from one part of a system to another." + is_abstract: true + opt_uses: + - failed_communication_alarm + implements: + - EQUIPMENT + +SENSOR: + guid: "4fa42531-26a8-4d1f-a0b3-a7f6bb5623e1" + description: "Stand-alone sensing device. Used to model individual sensors when they don't belong explicitly to one piece of equipment." + is_abstract: true + implements: + - EQUIPMENT + TK: guid: "ada23c08-00af-4967-8148-33239e8564f7" description: "Device used to store media. Used to model individual tanks when they don't belong explicitly to one piece of equipment." is_abstract: true implements: - EQUIPMENT + +USER_INTERFACE: + guid: "ec863942-5bda-4f44-b6ab-af80e72a0f2e" + description: "Generic user interface." + is_abstract: true + implements: + - EQUIPMENT + +VLV: + guid: "3b576a44-4ab8-4e9b-ad8f-65f1b9f08238" + description: "Tag for valves. Valves are devices which control the flow of water." + is_abstract: true + opt_uses: + - failed_communication_alarm + implements: + - EQUIPMENT \ No newline at end of file From 519b38411cb4dce1d7d2e600e7e7ea5090b84fdc Mon Sep 17 00:00:00 2001 From: Claire Stirdivant Date: Thu, 2 May 2024 17:02:09 +0000 Subject: [PATCH 2/2] typo fix --- ontology/yaml/resources/HVAC/entity_types/VLV.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/ontology/yaml/resources/HVAC/entity_types/VLV.yaml b/ontology/yaml/resources/HVAC/entity_types/VLV.yaml index 1782942251..031250aa08 100644 --- a/ontology/yaml/resources/HVAC/entity_types/VLV.yaml +++ b/ontology/yaml/resources/HVAC/entity_types/VLV.yaml @@ -16,7 +16,7 @@ ### Canonical Types ### ######################## -VLV_CHWVM_RTM_DTM: # TODO: remodel this, it is redudant to implement an abstract with `valve` fields +VLV_CHWVM_RTM_DTM: # TODO: remodel this, it is redundant to implement an abstract with `valve` fields guid: "b2223a12-07e8-455b-8ae4-eed3942df5a8" description: "Chilled water valve with discharge and return temperature monitoring." is_canonical: true @@ -34,7 +34,7 @@ VLV_HWVM: # If we want to keep this, should match CHW valve (i.e. add RTM and DT - /VLV # inherits from global namespace - HWVM -VLV_CHWPVM: # TODO: remodel this, it is redudant to implement an abstract with `valve` fields +VLV_CHWPVM: # TODO: remodel this, it is redundant to implement an abstract with `valve` fields guid: "4222857f-3f92-4663-83ac-0bb11550f568" description: "Chilled water pressure control valve." is_canonical: true @@ -42,7 +42,7 @@ VLV_CHWPVM: # TODO: remodel this, it is redudant to implement an abstract with ` - /VLV # inherits from global namespace - CHWPVM -VLV_HWPVM: # TODO: remodel this, it is redudant to implement an abstract with `valve` fields +VLV_HWPVM: # TODO: remodel this, it is redundant to implement an abstract with `valve` fields guid: "8ead3ca8-7f64-421c-9293-fcbf440bcc4f" description: "Heating water pressure control valve." is_canonical: true @@ -50,7 +50,7 @@ VLV_HWPVM: # TODO: remodel this, it is redudant to implement an abstract with `v - /VLV # inherits from global namespace - HWPVM -VLV_CDWPVM: # TODO: remodel this, it is redudant to implement an abstract with `valve` fields +VLV_CDWPVM: # TODO: remodel this, it is redundant to implement an abstract with `valve` fields guid: "f656bec8-3061-4e60-b7d2-00f754bad5af" description: "Condensing water pressure control valve." is_canonical: true @@ -58,7 +58,7 @@ VLV_CDWPVM: # TODO: remodel this, it is redudant to implement an abstract with ` - /VLV # inherits from global namespace - CDWPVM -VLV_SWCM: # TODO: remodel this, it is redudant to implement an abstract with `valve` fields +VLV_SWCM: # TODO: remodel this, it is redundant to implement an abstract with `valve` fields guid: "e0552cad-7620-462c-9571-b832cda303f5" description: "Solenoid water valve control and monitoring." is_canonical: true