Merge remote-tracking branch 'upstream/master'

ontology/docs/meter_loads.md

@@ -1,33 +1,20 @@
 # Meter Load Designation
 
-Digital Buildings provides abstract models that can be used to represent various 
-types of loads within a building and can be connected to meter entities to indicate the types
-of loads measured by each metering device. This document describes how these loadtypes 
-should be created and connected within a building configuration file.
+Digital Buildings provides abstract models that can be used to represent various types of loads within a building and can be connected to meter entities to indicate the types of loads measured by each metering device. This document describes how these loadtypes should be created and connected within a building configuration file.
+
+*   For an explanation of building configuration files see [building_config](building_config.md)
 
-*   For an explanation of building configuration files see
-    [building_config](building_config.md)
-
 ### Create the Building Entity and Meter Device Entity
 
-Use the syntax described in [building_config](building_config.md) to create a
-facility entity for the building and a reporting entity for the meter device.
-A `CONTAINS` connection should be used to indicate that the meter exists within
-the building.
+Use the syntax described in [building_config](building_config.md) to create a facility entity for the building and a reporting entity for the meter device. A `CONTAINS` connection should be used to indicate that the meter exists within the building.
 
 ### Create an Abstract Loadtype Entity
 
-Create a loadtype entity to represent each of the types of loads the meters in 
-the building measure. The entity will consist of a single abstract loadtype 
-found in the file called `LOADTYPES.yaml` in the `METER` namespace. The abstract
-loadtype does not implement any fields. A `CONTAINS` connection should be used 
-to indicate that the load exists within the building.
+Create a loadtype entity to represent each of the types of loads the meters in the building measure. The entity will consist of a single abstract loadtype found in the file called `LOADTYPES.yaml` in the `METER` namespace. The abstract loadtype does not implement any fields. A `CONTAINS` connection should be used to indicate that the load exists within the building.
 
 ### Connect the Loadtype Entity to the Meter Entity via a `MEASURES` Connection
 
-Add a `MEASURES` connection to the loadtype entity to indicate which meter(s) 
-provide data for it. A building may have multiple meters that 
-measure the same loadtype.
+Add a `MEASURES` connection to the loadtype entity to indicate which meter(s) provide data for it. A building may have multiple meters that measure the same loadtype.
 
 ## Example Building Layout and Config
 
@@ -36,7 +23,7 @@ Example full building-loadtype-meter layout:
 ![image](https://github.com/shambergoldstein/digitalbuildings/assets/124837286/427e4c03-c132-468c-94e7-20486117643a)
 
 Example building-loadtype-meter connection in building configuration file:
-``` yaml  
+``` yaml
 # The building
 ccb-342:
   code: BLDG-123
@@ -62,6 +49,6 @@ dde-453:
       present_value: points.kW.present_value
       units:
         key: pointset.points.kW.units
-        values: 
+        values:
           kilowatts: "kW"
 ```

ontology/yaml/resources/ELECTRICAL/entity_types/ABSTRACT.yaml

@@ -175,10 +175,19 @@ SRC2:
   - source2_phase1_phase2_voltage_sensor
   - source2_phase2_phase3_voltage_sensor
   - source2_phase3_phase1_voltage_sensor
-  - source2_frequency_sensor 
+  - source2_frequency_sensor
   opt_uses:
   - source2_phase1_phase2_over_voltage_status
   - source2_phase2_phase3_over_voltage_status
   - source2_phase3_phase1_over_voltage_status
   - source2_over_voltage_status
   - source2_lost_power_alarm
+
+SPM:
+  guid: "ff13347e-e823-4adc-a2e4-c02cbae45a84"
+  description: "ATS switch position monitoring."
+  is_abstract: true
+  uses:
+  - switch_position_status
+  - line_power_status
+  - emergency_power_status

ontology/yaml/resources/ELECTRICAL/entity_types/ATS.yaml

@@ -29,3 +29,13 @@ ATS_SRC1_SRC2:
   opt_uses:
   - generator_status
   - fire_alarm
+
+ATS_SPM:
+  guid: "7d1b371e-cdbe-439d-9a35-f5ace7f6dcbb"
+  description: "Automatic transfer switch with switch position monitoring."
+  is_canonical: true
+  implements:
+  - ATS
+  - SPM
+  opt_uses:
+  - fire_alarm

ontology/yaml/resources/HVAC/entity_types/ABSTRACT.yaml

@@ -5557,6 +5557,26 @@ SWTM:
   uses:
   - supply_water_temperature_sensor
 
+SWTM2X:
+  guid: "5fe10f00-bfb6-4493-b8bd-0d58f47a88b4"
+  description: "Dual supply water temperature monitoring."
+  is_abstract: true
+  implements:
+  - MONITORING
+  opt_uses:
+  - cooling_request_count_1
+  - heating_request_count_1
+  - return_water_temperature_sensor_1
+  - high_supply_water_temperature_alarm_1
+  - low_supply_water_temperature_alarm_1
+  - cooling_request_count_2
+  - heating_request_count_2
+  - return_water_temperature_sensor_2
+  - high_supply_water_temperature_alarm_2
+  - low_supply_water_temperature_alarm_2
+  uses:
+  - supply_water_temperature_sensor_1
+  - supply_water_temperature_sensor_2
 
 RWTM:
   guid: "c317c88d-f090-4cd9-9289-6e03e24e496f"
@@ -7132,6 +7152,7 @@ LM:
   - level_status
   - percentage_sensor
 
+
 LHLM:
   guid: "647a4576-b503-43cd-b3b7-e1a9c6856695"
   description: "High and Low Level Monitoring for tanks."
@@ -7140,6 +7161,18 @@ LHLM:
   - water_high_level_status
   - water_low_level_status
 
+
+LHLM2X:
+  guid: "dbd0f972-f56f-4455-a8e5-4a4cb99c9a0a"
+  description: "Dual High and Low Level Monitoring for tanks."
+  is_abstract: true
+  uses:
+  - water_high_level_status_1
+  - water_low_level_status_1
+  - water_high_level_status_2
+  - water_low_level_status_2
+
+
 PLPM:
   guid: "87da5960-a441-49a1-8f80-05acdbf32426"
   description: "Pipeline Fluid pressure monitoring"

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

@@ -70,6 +70,15 @@ PMP_SS_VSC_WDPC:
   - VSC
   - WDPC
 
+PMP_SS_LHLM:
+  guid: "0c3cc1e4-6710-4dab-a0bc-35708f9c2b91"
+  description: "Sump Pump with water level monitoring."
+  is_canonical: true
+  implements:
+  - PMP
+  - SS
+  - LHLM
+
 PMP_SS_VSFC:
   guid: "08683c47-596a-4e52-8545-5079201b55df"
   description: "PMP device with pump frequency control"

ontology/yaml/resources/HVAC/entity_types/SDC.yaml

@@ -103,7 +103,7 @@ SDC_EXT_TLT_NORTH_WIND2X:
   uses:
   - north_wind_linearvelocity_sensor_1
   - north_wind_linearvelocity_sensor_2
-  
+
 SDC_EXT_TLT_SOUTH_WIND2X:
   guid: "426eace1-f4c8-49d0-acef-0fad52d9cc44"
   description: "Directional shade (South) with two wind sensors."

ontology/yaml/resources/HVAC/entity_types/TANK.yaml

@@ -42,6 +42,15 @@ TK_LHLM_SWTM:
   - LHLM
   - SWTM
 
+TK_LHLM2X_SWTM2X:
+  guid: "e50038e9-60fc-4604-a632-5300043f93cc"
+  description: "Dual section Tank with supply water temperature monitoring with high and low water level monitoring."
+  is_canonical: true
+  implements:
+  - /TK # Inherits from global namespace
+  - LHLM2X
+  - SWTM2X
+
 TK_SWTC_PHWTC:
   guid: "afec4cde-0aa9-4f75-9cf8-1fa1512fd49a"
   description: "Tank with supply water temperature control and potable water temperature monitoring."

ontology/yaml/resources/LIGHTING/entity_types/LGRP.yaml

@@ -314,7 +314,7 @@ LGRP_OS_AWIC:
   is_canonical: true
   implements:
   - LGRP
-  - OS 
+  - OS
   - AWIC
   uses:
   - group_mode

ontology/yaml/resources/fields/telemetry_fields.yaml

@@ -3526,4 +3526,13 @@ literals:
     flexible_max: 44.704
 - south_wind_linearvelocity_sensor:
     flexible_min: 0.0
-    flexible_max: 44.704
+    flexible_max: 44.704
+- switch_position_status:
+  - NORMAL
+  - EMERGENCY
+- line_power_status:
+  - PRESENT
+  - ABSENT
+- emergency_power_status:
+  - PRESENT
+  - ABSENT

ontology/yaml/resources/states/states.yaml

@@ -94,6 +94,7 @@ BATTERY: "Operation mode or input power is via Battery"
 SYNCHRONOUS: "Mode of operation of inverter where inverter operation is in line with the bypass voltage and frequency"
 ASYNCHRONOUS: "Mode of operation of inverter where either the bypass supply fails or the inverter is not in line bypass voltage and frequency"
 SOFTSTART: "Mode of operation of rectifier where the input power supply is gradually turned on to avoid overloading"
+EMERGENCY: "Power source or mode of operation in critical situations when the primary power source or typical mode of operation fails."
 
 ## LIGHTING
 FADING: "An operation mode of a lighting dimmer: dimming speed based on a duration to dim from minimum to maximum."

ontology/yaml/resources/units/units.yaml

@@ -300,6 +300,15 @@ mass:
   tons:
     multiplier: 907184
     offset: 0
+  metric_tons:
+    multiplier: 1000000
+    offset: 0
+  uk_tons:
+    multiplier: 1016046.9088
+    offset: 0
+  us_tons:
+    multiplier: 907184.74
+    offset: 0
 massconcentration: concentration
 massflow:
   grams_per_second: STANDARD
@@ -318,6 +327,15 @@ massflow:
   tons_per_hour:
     multiplier: 251.996
     offset: 0
+  metric_tons_per_hour:
+    multiplier: 277.777777778
+    offset: 0
+  uk_tons_per_hour:
+    multiplier: 282.235252444
+    offset: 0
+  us_tons_per_hour:
+    multiplier: 251.995761111
+    offset: 0
   pounds_mass_per_hour:
     multiplier: 0.125998
     offset: 0