METER namespace revisions

ontology/yaml/resources/METERS/entity_types/ABSTRACT.yaml

@@ -75,9 +75,10 @@ PVCM:
   - phase2_neutral_line_voltage_sensor
   - phase3_neutral_line_voltage_sensor
 
+# TODO: rename to make this more intuitive
 PWMRDM:
   guid: "4bfb27f6-0a27-48d9-8830-81c84d95c8ab"
-  description: "Energy monitoring from Electrical Grid and Generator with run hours monitoring."
+  description: "Energy monitoring from electrical grid and generator with run hours monitoring."
   is_abstract: true
   uses:
   - generator_energy_accumulator
@@ -87,16 +88,51 @@ PWMRDM:
 
 TPWM:
   guid: "141dc3bf-85dd-4fce-9342-9a5462b3c274"
-  description: "Thermal power and thermal energy monitoring."
+  description: "Thermal power and thermal energy monitoring (typically used for heat meters)."
   is_abstract: true
   uses:
-    - thermal_energy_accumulator
-    - thermal_power_sensor
+  - thermal_energy_accumulator
+  - thermal_power_sensor
 
 VCM:
   guid: "dc4d2839-c00d-4935-bc67-013f7721535f"
-  description: "Current and voltage monitoring"
+  description: "Current and voltage monitoring."
   is_abstract: true
   uses:
   - current_sensor
   - voltage_sensor
+
+VAM:
+  guid: "8f73213c-b12d-45e3-954d-6c876ddb12fc"
+  description: "Volume accumulator monitoring."
+  is_abstract: true
+  opt_uses:
+  - flowrate_sensor
+  uses:
+  - volume_accumulator
+
+WVAM:
+  guid: "a9b16412-be29-4dd8-815f-544bf72a8fae"
+  description: "Water volume accumulator monitoring."
+  is_abstract: true
+  opt_uses:
+  - water_flowrate_sensor
+  - water_linearvelocity_sensor
+  uses:
+  - water_volume_accumulator
+
+GVAM:
+  guid: "c7761aab-7560-4c62-9095-e9931b0f4c81"
+  description: "Gas volume accumulator monitoring."
+  is_abstract: true
+  opt_uses:
+  - gas_flowrate_sensor
+  uses:
+  - gas_volume_accumulator
+
+GTM:
+  guid: "011225da-4eb3-4875-a1df-0f3cc3a2a7a0"
+  description: "Gas temperature monitoring."
+  is_abstract: true
+  uses:
+  - gas_temperature_sensor

ontology/yaml/resources/METERS/entity_types/EM.yaml

@@ -53,9 +53,6 @@ EM_PWM_PVCM:
   - EM
   - PWM
   - PVCM
-  opt_uses:
-  - reactive_energy_accumulator
-  - apparent_energy_accumulator
 
 EM_PWM_AVCM:
   guid: "441a3b57-05e7-426d-bed9-061f28f21b3a"
@@ -127,6 +124,7 @@ EM_ION:
   - EM_PWM_AVCM_PLPM_PVCM
   - DEPRECATED
 
+# TODO: fully delete this type (duplicate of EM_PWM_NONCANONICAL_2 and not implemented by any entities)
 EM_PWM_NONCANONICAL_1:
   guid: "5063ee14-dd44-4d34-a17c-9b0d4f5cff43"
   description: "Non-standard type."
@@ -154,6 +152,7 @@ EM_PWM_NONCANONICAL_2:
   - average_line_current_sensor
   - average_inter_line_voltage_sensor
 
+# TODO: fully delete this type (not implemented by any entities)
 EM_PWM_PLPM_PVCM_NONCANONICAL_2:
   guid: "867a7be3-2023-49c2-a1da-4805abfaf9a0"
   description: "SE PM5100 Meter"

ontology/yaml/resources/METERS/entity_types/FM.yaml

@@ -12,15 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-FM_STANDARD:
+FM_VAM:
   guid: "05f00511-9d04-4c98-ac9f-6aba9f0c9fe7"
-  description: "Standard flow meter typically for liquid."
+  description: "Standard closed-loop flow meter, typically for liquid."
+  is_canonical: true
   implements:
   - FM
-  is_canonical: true
-  uses:
-  - volume_accumulator
-  - flowrate_sensor
-  opt_uses:
-  - failed_alarm
-
+  - VAM

ontology/yaml/resources/METERS/entity_types/GENERALTYPES.yaml

@@ -19,38 +19,50 @@ MTR:
   is_abstract: true
   implements:
   - EQUIPMENT
+  opt_uses:
+  - failed_alarm
 
 EM:
   guid: "cba37f53-9e19-4498-80d1-6053d993f4ac"
   description: "Tag for all the electrical meter types."
+  is_abstract: true
   implements:
   - MTR
-  is_abstract: true
+  opt_uses:
+  - failed_alarm
 
 GM:
   guid: "919ece3f-2f6f-4c9d-adcf-2a77eed49185"
   description: "Tag for all gas meters."
+  is_abstract: true
   implements:
   - MTR
-  is_abstract: true
+  opt_uses:
+  - failed_alarm
 
 FM:
   guid: "e89d919e-ecfb-4852-aeab-c087b0fabf6d"
   description: "Tag for all closed-loop system flow meters. Distinct from water meters which are open-loop systems."
   is_abstract: true
   implements:
-  - MTR  
+  - MTR
+  opt_uses:
+  - failed_alarm  
 
 WM:
   guid: "c1df623f-c71b-45a1-89eb-2bc7c82f291a"
   description: "Tag for all water meters (open-loop), such as the main building water consumption meter."
+  is_abstract: true
   implements:
   - MTR
-  is_abstract: true
+  opt_uses:
+  - failed_alarm
 
 HM:
   guid: "9496631b-c154-4d86-857d-c2ffff88ffe4"
   description: "Tag for all heat meters (cooling or heating), commonly referred to as BTU meters."
   is_abstract: true
   implements:
   - MTR
+  opt_uses:
+  - failed_alarm

ontology/yaml/resources/METERS/entity_types/GM.yaml

@@ -12,26 +12,22 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-GM_STANDARD:
+GM_GVAM_GTM:
   guid: "96de90c9-fb62-4557-b29c-aa723e255a8f"
-  description: "The typical building gas meter."
+  description: "Gas meter that measures volume and temperature."
+  is_canonical: true
   implements:
   - GM
-  is_canonical: true
-  uses:
-  - gas_flowrate_sensor
-  - gas_volume_accumulator
-  - gas_temperature_sensor
+  - GVAM
+  - GTM
 
-GM_PULSE:
+GM_GVAM:
   guid: "0b74bcd2-f3c6-42b2-9a91-88f34c5d472d"
-  description: "Gas meter that operates by counting pulses, interpreted into flow and accumulated volume."
+  description: "Gas meter that measures volume accumulated (e.g., pulse meter)."
+  is_canonical: true
   implements:
   - GM
-  is_canonical: true
-  uses:
-  - gas_flowrate_sensor
-  - gas_volume_accumulator
+  - GVAM
 
 GM_TPWM:
   guid: "223b81fb-9fcf-475b-a2f5-ad5d1364454c"
@@ -41,4 +37,4 @@ GM_TPWM:
   - GM
   - TPWM
   opt_uses:
-  - gas_temperature_sensor
+  - gas_temperature_sensor # TODO: examine optional usage of this (remove and implement GTM, if possible)

ontology/yaml/resources/METERS/entity_types/HM.yaml

@@ -12,55 +12,51 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
+# TODO: rename this type
 HM_STANDARD:
   guid: "7f96b71e-3f47-4872-b770-71a4b8021677"
   description: "General water-side thermal load heat meter."
   is_canonical: true
   implements:
   - HM
+  - TPWM
+  - HVAC/WDT # inherits from HVAC namespace
   uses:
-  - flowrate_sensor
-  - supply_water_temperature_sensor
-  - return_water_temperature_sensor
-  - thermal_power_sensor
-  - thermal_energy_accumulator
+  - flowrate_sensor # TODO: change to water_flowrate_sensor (for continuity) and implement WVAM
   opt_uses:
-  - water_volume_accumulator
+  - water_volume_accumulator # TODO: determine if this can be promoted to `uses` (if so, implement WVAM)
 
 HM_CHW:
   guid: "4439f98a-c52b-4fff-8765-84e689862423"
   description: "Cooling load heat meter."
+  is_canonical: true 
   implements:
   - HM
-  is_canonical: true
+  - HVAC/CHWDT # inherits from HVAC namespace
+  - HVAC/CHWFRM # inherits from HVAC namespace
   uses:
-  - chilled_water_flowrate_sensor
-  - chilled_supply_water_temperature_sensor
-  - chilled_return_water_temperature_sensor
-  - cooling_thermal_power_sensor
-  - cooling_thermal_energy_accumulator
+  - cooling_thermal_power_sensor # TODO: justify if `cooling` needs to be specified here, if not implement TPWM
+  - cooling_thermal_energy_accumulator # TODO: justify if `cooling` needs to be specified here, if not implement TPWM
   opt_uses:
   - differential_temperature_sensor
-  - failed_alarm
 
-HM_CHW_WAC:
+HM_CHW_WVAM:
   guid: "441029f3-1324-42c5-aca2-74138500917a"
   description: "Cooling load heat meter with total chilled water volume accumulator."
+  is_canonical: true
   implements:
   - HM_CHW
-  is_canonical: true
-  uses:
-  - water_volume_accumulator
+  - WVAM
 
 HM_HW:
   guid: "12427c9d-7d96-4551-b5de-e7d78a7d3674"
   description: "Heating load heat meter."
+  is_canonical: true  
   implements:
   - HM
-  is_canonical: true
+  - HVAC/HWDT # inherits from HVAC namespace
   uses:
-  - heating_water_flowrate_sensor
-  - heating_supply_water_temperature_sensor
-  - heating_return_water_temperature_sensor
-  - heating_thermal_power_sensor
-  - heating_thermal_energy_accumulator
+  - heating_water_flowrate_sensor # TODO: justify if `heating` needs to be specified here
+  - heating_thermal_power_sensor # TODO: justify if `heating` needs to be specified here, if not implement TPWM
+  - heating_thermal_energy_accumulator # TODO: justify if `heating` needs to be specified here, if not implement TPWM

ontology/yaml/resources/METERS/entity_types/WM.yaml

@@ -12,27 +12,26 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-WM_STANDARD:
+WM_WVAM:
   guid: "7cbdf4a9-82f0-4dd5-991f-14984cbce4cb"
-  description: "Standard building water meter."
+  description: "Standard building water meter with volume monitoring."
+  is_canonical: true
   implements:
   - WM
-  is_canonical: true
-  uses:
-  - water_volume_accumulator
+  - WVAM # TODO: we are creating tech debt to model it like this (in theory we should not need to specify `water` and could simply use the VAM type)
   opt_uses:
-  - failed_alarm
-  - flowrate_sensor
+  - flowrate_sensor # TODO: remove this and rely on optional usage of `water_flowrate_sensor` in the WVAM type
 
+# TODO: potentially deprecate this type (not currently implemented by any entities)
 WM_WF:
   guid: "df942136-4b98-4da7-9e68-acc210d6cf03"
   description: "Water supply flow rate meter with counter."
+  is_canonical: true
   implements:
   - WM
-  is_canonical: true
   uses:
-  - supply_water_flowrate_sensor
+  - supply_water_flowrate_sensor # TODO: examine why `supply` is needed
   opt_uses:
-  - supply_water_volume_accumulator
-  - water_linearvelocity_sensor
-  - water_volume_accumulator
+  - supply_water_volume_accumulator # TODO: examine why `supply` is needed
+  - water_linearvelocity_sensor # TODO: remove and rely on optional usage in WVAM type
+  - water_volume_accumulator # TODO: remove and rely on optional usage in WVAM type