elevate PMP and VLV to the global namespace

ontology/yaml/resources/HVAC/entity_types/GENERALTYPES.yaml

@@ -77,15 +77,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."
@@ -286,15 +277,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."

ontology/yaml/resources/HVAC/entity_types/PMP.yaml

@@ -21,15 +21,15 @@ PMP_SS:
   description: "Typical pump."
   is_canonical: true
   implements:
-  - PMP
+  - /PMP # inherits from global namespace
   - SS
 
 PMP_SS_VSC:
   guid: "4e1f807a-1811-4cad-9a6f-9776320a7de0"
   description: "Typical variable speed pump."
   is_canonical: true
   implements:
-  - PMP
+  - /PMP # inherits from global namespace
   - SS
   - VSC
 
@@ -38,15 +38,15 @@ PMP_DRPM:
   description: "Pump implemented with drain pump monitoring ."
   is_canonical: true
   implements:
-  - PMP
+  - /PMP # inherits from global namespace
   - DRPM
 
 PMP_SS_VSC_WDPM:
   guid: "6a2cba7a-5bfc-4cc6-9f82-52389d266159"
   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

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 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
   implements:
-  - VLV
+  - /VLV # inherits from global namespace
   - CHWVM
   - RTM
   - DTM
@@ -31,47 +31,47 @@ 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_CHWVM_CHWDT_CLPM:
   guid: "e5d23585-6ac5-4d3b-bc2e-4278ffc6391d"
   description: "Chilled water pressure control valve with differential temperature and thermal load monitoring."
   is_canonical: true
   implements:
-  - VLV
+  - /VLV # inherits from global namespace
   - CHWVM
   - CHWDT
   - CLPM
 
-VLV_CHWPVM:
+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
   implements:
-  - VLV
+  - /VLV # inherits from global namespace
   - CHWPVM
 
-VLV_HWPVM:
+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
   implements:
-  - VLV
+  - /VLV # inherits from global namespace
   - HWPVM
 
-VLV_CDWPVM:
+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
   implements:
-  - VLV
+  - /VLV # inherits from global namespace
   - CDWPVM
 
-VLV_SWCM:
+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
   implements:
-  - VLV
+  - /VLV # inherits from global namespace
   - SWCM

ontology/yaml/resources/PLUMBING/entity_types/GENERALTYPES.yaml

@@ -12,27 +12,13 @@
 # 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"
   description: "Waste Compactor system used for compacting organic waste essential for conversion into manure."
   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"

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  
 
 

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

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

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