Merge branch 'master' of https://github.com/evgeniya-engel/digitalbui…

…ldings

merge

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

@@ -3674,6 +3674,8 @@ MXVPM:
   guid: "4bb25777-d661-4fd3-9f8f-a84b349ada87"
   description: "Mixing valve percent monitoring."
   is_abstract: true
+  opt_uses:
+  - mixing_valve_percentage_sensor
   uses:
   - mixing_valve_percentage_command
   implements:
@@ -7026,6 +7028,43 @@ VSMC:
   - high_speed_status
   - schedule_run_command
 
+CO2DSPMADC:
+  guid: "316d6473-f187-45ce-9b0e-35b8149e83ce"
+  description: "Dual setpoint CO2 control with mixed air damper (for recirculated air in AHU)."
+  is_abstract: true
+  uses:
+  - mixed_air_damper_open_command
+  - mixed_air_damper_closed_command
+  - low_limit_return_air_co2_concentration_setpoint
+  - high_limit_return_air_co2_concentration_setpoint
+  - return_air_co2_concentration_sensor
+  implements:
+  - CONTROL
+
+HTWHLZTC:
+  guid: "0d063fbc-57cc-4678-9516-d9372e9ccf15"
+  description: "Heat wheel which controls zone temperature using speed control."
+  is_abstract: true
+  implements:
+  - CONTROL
+  opt_uses:
+  - exhaust_air_temperature_sensor
+  - heat_wheel_speed_percentage_sensor
+  - return_air_temperature_sensor
+  - supply_air_temperature_sensor
+  - failed_exhaust_air_temperature_alarm
+  - high_return_air_temperature_alarm
+  - high_supply_air_temperature_alarm
+  - low_return_air_temperature_alarm
+  - low_supply_air_temperature_alarm
+  uses:
+  - heat_wheel_run_command
+  - heat_wheel_run_status
+  - heat_wheel_speed_percentage_command
+  - outside_air_temperature_sensor
+  - zone_air_temperature_sensor
+  - zone_air_temperature_setpoint
+
 SDM2X:
   guid: "b56e4a52-c988-448a-847d-25710ae4aaef"
   description: "Supply air damper monitoring, dual status fields."
@@ -7277,6 +7316,9 @@ CPC2X:
   - circulation_pump_run_status_1
   - circulation_pump_run_command_2
   - circulation_pump_run_status_2
+  opt_uses:
+  - failed_circulation_pump_alarm_1
+  - failed_circulation_pump_alarm_2
 
 SDHC:
   guid: "de065843-b1a9-4d2e-b751-31d7af8e8991"
@@ -7306,3 +7348,38 @@ FPHC:
   uses:
   - heating_water_valve_percentage_command
   - chilled_water_valve_percentage_command
+
+SSTC:
+  guid: "3aefe568-b8eb-485e-a3d9-38ac3bb9906d"
+  description: "Supply steam valve monitoring to control water temperature on supply side for steam exchanger."
+  is_abstract: true
+  opt_uses:
+  - supply_steam_valve_percentage_sensor
+  uses:
+  - supply_steam_valve_percentage_command
+  - heating_supply_water_temperature_sensor
+  - heating_supply_water_temperature_setpoint
+
+COC2XDSP:
+  guid: "fa7cba8d-be4d-4968-a5bf-f55429006b77"
+  description: "Dual setpoint CO concentration control with 2 sensors."
+  is_abstract: true
+  uses:
+  - high_limit_zone_air_co_concentration_setpoint
+  - low_limit_zone_air_co_concentration_setpoint
+  - zone_air_co_concentration_sensor_1
+  - zone_air_co_concentration_sensor_2
+  implements:
+  - CONTROL
+
+NO2C2XDSP:
+  guid: "7a76fa65-88d2-4cea-8297-3bdb4ca507e4"
+  description: "Dual setpoint NO2 concentration control with 2 sensors."
+  is_abstract: true
+  uses:
+  - high_limit_zone_air_no2_concentration_setpoint
+  - low_limit_zone_air_no2_concentration_setpoint
+  - zone_air_no2_concentration_sensor_1
+  - zone_air_no2_concentration_sensor_2
+  implements:
+  - CONTROL

ontology/yaml/resources/HVAC/entity_types/AHU.yaml

@@ -918,6 +918,26 @@ AHU_DFSS_CHWDT_DTM_RTC_RWISOVPC_OAFC_FDPSM2X:
   - OAFC
   - FDPSM2X
 
+AHU_SFSS_SFVSC_EFSS_EFVSC_HTWHLZTC_HWZTC_CHWZTC_SSPC_RSPC_CO2DSPMADC_MTM_ECONZ_FDPM3X:
+  guid: "d1f96a1d-3c49-49c9-8ff7-aa60f1f7e10b"
+  description: "AHU that serves multiple dampers all feeding a single zone."
+  is_canonical: true
+  implements:
+  - AHU
+  - SFSS
+  - SFVSC
+  - EFSS
+  - EFVSC
+  - HTWHLZTC
+  - HWZTC
+  - CHWZTC
+  - SSPC
+  - RSPC
+  - CO2DSPMADC
+  - MTM
+  - ECONZ
+  - FDPM3X
+
 ### Multi-zone Units ###
 
 AHU_DXSC_ECON_EFSS_SFSS:

ontology/yaml/resources/HVAC/entity_types/FAN.yaml

@@ -562,6 +562,16 @@ FAN_SS_FDPM_VSC_SRC:
   - VSC
   - SRC
 
+FAN_HLC_COC2XDSP_NO2C2XDSP:
+  guid: "69a67398-f2d7-4fc7-b60a-945be99012b2"
+  description: "Two-speed fan (low/high) with CO concentration dual setpoint control and NO2 concentration dual setpoint control with 2 sensors."
+  is_canonical: true
+  implements:
+  - FAN
+  - HLC
+  - COC2XDSP
+  - NO2C2XDSP
+
 ###################################
 ### Existing Non-standard Types ###
 ###################################

ontology/yaml/resources/HVAC/entity_types/FCU.yaml

@@ -1255,6 +1255,15 @@ FCU_DFSS_DFVSC_FDPM_CHWDC_SRC_DFRMM:
   - SRC
   - DFRMM
 
+FCU_DFSS_CHWRC:
+  guid: "854f3eff-07db-4324-a4b3-84e19f6a8639"
+  description: "CRAC unit with discharge fan and return temperature control."
+  is_canonical: true
+  implements:
+  - FCU
+  - DFSS
+  - CHWRC
+
 FCU_DXZTC_DFSS:
   guid: "5688519e-f88e-4620-8bd5-89d91467028d"
   description: "FCU with SS, discharge temp sensors, zone control and sensor, filter change"
@@ -1338,6 +1347,17 @@ FCU_DFSS_CHWDC_CSP_RTM_DXZC:
   - filter_alarm
   - run_mode
 
+FCU_SS_HTRC_DTM_ZTM:
+  guid: "3d9b6b87-0770-4ae6-9bfc-8f729341ccac"
+  description: "FCU with return temperature control, discharge temperature monitoring, zone temperature monitorning and start/stop control."
+  is_canonical: true
+  implements:
+  - FCU
+  - SS
+  - HTRC
+  - DTM
+  - ZTM
+
 ###################################
 ### Existing Non-standard Types ###
 ###################################
@@ -1790,6 +1810,15 @@ FCU_DSP_DFVSC_DTM_RTM:
   - DTM
   - RTM
 
+FCU_DFSS_DFSMC_HWRC:
+  guid: "1388eea8-a039-4b33-8613-24ae9de719dd"
+  description: "Warm air curtain with return air temperature control."
+  implements:
+  - FCU
+  - DFSS
+  - DFSMC
+  - HWRC
+
 FCU_DFVSC_RTM_CO2M_HWZTC_CHWZTC:
   guid: "6f6fd049-576c-4f0a-894d-a6433575b8dd"
   description: "Fan coil unit with zone temperature control, heating water and chilled water valve monitoring."

ontology/yaml/resources/HVAC/entity_types/HX.yaml

@@ -187,3 +187,12 @@ HX_CWDT_HSWTC_HWDPC_HWBYPVPM:
   - HSWTC
   - HWDPC
   - HWBYPVPM
+
+HX_SSTC_SSSPC:
+  guid: "02c3c81d-241c-4868-b260-9c580c29379b"
+  description: "Steam exchanger with heating water temperature control and steam static pressure control on supply side."
+  is_canonical: true
+  implements:
+  - HX
+  - SSTC
+  - SSSPC

ontology/yaml/resources/HVAC/entity_types/MAU.yaml

@@ -16,6 +16,20 @@
 ### Canonical Types  ###
 ########################
 
+MAU_HWSC_SFM_SFVSC_FDPM_FDPSM_SDM_SSPC:
+  guid: "5d055bc2-ea29-4d1e-beb9-e082f7bea4c7"
+  description: "Make-up air unit with heating control"
+  is_canonical: true
+  implements:
+  - MAU
+  - HWSC
+  - SFM
+  - SFVSC
+  - FDPM
+  - FDPSM
+  - SDM
+  - SSPC
+
 MAU_SFSS_STM:
   guid: "9532ed28-f40c-472b-90aa-4a679911ef17"
   description: "Simple make-up air unit."

ontology/yaml/resources/fields/telemetry_fields.yaml

@@ -148,6 +148,10 @@ literals:
   - HIGH
   - OFF
   - VFD
+  - TWENTY_PERCENT
+  - FORTY_PERCENT
+  - SIXTY_PERCENT
+  - EIGHTY_PERCENT
 - discharge_fan_speed_percentage_command:
     fixed_min: 0.0
     fixed_max: 100.0
@@ -3212,6 +3216,18 @@ literals:
 - low_discharge_air_static_pressure_alarm:
   - ACTIVE
   - INACTIVE
+- mixed_air_damper_open_command:
+  - ON
+  - OFF
+- mixed_air_damper_closed_command:
+  - ON
+  - OFF
+- low_limit_return_air_co2_concentration_setpoint:
+    flexible_min: 0.00005
+    flexible_max: 0.005
+- high_limit_return_air_co2_concentration_setpoint:
+    flexible_min: 0.00005
+    flexible_max: 0.005
 - average_zone_air_co2_concentration_setpoint:
     flexible_min: 0.00005
     flexible_max: 0.005
@@ -3229,4 +3245,16 @@ literals:
     flexible_max: 80
 - tamper_alarm:
   - ACTIVE
-  - INACTIVE
+  - INACTIVE
+- supply_steam_valve_percentage_command:
+    fixed_min: 0.0
+    fixed_max: 100.0
+- supply_steam_valve_percentage_sensor:
+    fixed_min: 0.0
+    fixed_max: 100.0
+- high_limit_zone_air_no2_concentration_setpoint:
+    fixed_min: 0.0
+    flexible_max: 0.0005
+- low_limit_zone_air_no2_concentration_setpoint:
+    fixed_min: 0.0
+    flexible_max: 0.0005

ontology/yaml/resources/states/states.yaml

@@ -27,6 +27,10 @@ VFD: Discrete speed (frequency) control
 BYPASS: Bypassing an element or entity.
 DEHUMIDIFY: Modes of operation in DX unit where the unit acts as a dehumidifier by removing moisture from air
 FAN_ONLY: Modes of operation in DX unit where only fan runs and heating/cooling is disabled
+TWENTY_PERCENT: Speed of 20 percent of the maximum
+FORTY_PERCENT: Speed of 40 percent of the maximum
+SIXTY_PERCENT: Speed of 60 percent of the maximum
+EIGHTY_PERCENT: Speed of 80 percent of the maximum
 
 # Moved from HVAC namespace because all fields are currently global in DL.
 COMMISSIONING: The fan speed and valve positions are set to preconfigured parameters.

tools/README.md

@@ -3,16 +3,16 @@
 Various tools have been developed to support the use of the Digital Buildings Ontology and Building Configuration files. 
 
 The tools and their functions are summarized below:
-  * [ABEL](./abel/README.md) generates from/to Google spreadsheet/[Building Configuration](../ontology/docs/building_config.md).
-  * [Explorer](./explorer/README.md) allows users to explorer the ontology types and their associated fields.
+  * [ABEL](./abel/README.md) generates from a Google Sheets spreadsheet to a [Building Configuration YAML file](../ontology/docs/building_config.md) (and vice versa).
+  * [Explorer](./explorer/README.md) allows users to explore the ontology types and their associated fields.
   * [Instance Validator](./validators/instance_validator/README.md) allows users to validate a concrete instance of the ontology (i.e., a building configuration file).
     * A sub-function of the Instance Validator is to also validate telemetry messages for each reporting entity in the building configuration file using [Telemetry Validator](./validators/instance_validator/README.md#telemetry-validation).
   * [Ontology Validator](./validators/ontology_validator/README.md) allows users to validate a local version of the YAML ontology upon a change or an extension.
 
 ## Digital Buildings Toolkit
 
 The Digital Buildings Toolkit provides a centralized method for interfacing with the following Digital Buildings tools:
-  * Instance Validator (with optional Telemetry Validator)
+  * Instance Validator (with optional telemetry validation)
   * GUID generator
 
 There are currently two methods for interacting with the Toolkit: the Toolkit Web Application (currently in alpha) and the Toolkit Command Line Interface (CLI).
@@ -29,7 +29,7 @@ To install please follow the instructions below.
 
 #### Create a Virtual Environment
 
-First, create a virtual environment with `venv` followed by the environment name (in this example: `tooling`) in the digitalbuildings repository.
+First, create a virtual environment with `venv` followed by the environment name (in this example: `tooling`) in the `digitalbuildings` repository.
 
 ```
 python -m venv tooling
@@ -47,6 +47,7 @@ Windows
 ```
 tooling\Scripts\activate
 ```
+
 #### Install Packages
 Next, you can either use pip or setup (to be deprecated) to install the necessary packages and dependencies.