Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Linter #1356

Merged
merged 5 commits into from
Jun 6, 2024
Merged

Linter #1356

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 8 additions & 21 deletions ontology/docs/meter_loads.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand All @@ -62,6 +49,6 @@ dde-453:
present_value: points.kW.present_value
units:
key: pointset.points.kW.units
values:
values:
kilowatts: "kW"
```
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ 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
Expand Down
2 changes: 1 addition & 1 deletion ontology/yaml/resources/HVAC/entity_types/SDC.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
2 changes: 1 addition & 1 deletion ontology/yaml/resources/HVAC/entity_types/TANK.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ TK_LHLM2X_SWTM2X:
implements:
- /TK # Inherits from global namespace
- LHLM2X
- SWTM2X
- SWTM2X

TK_SWTC_PHWTC:
guid: "afec4cde-0aa9-4f75-9cf8-1fa1512fd49a"
Expand Down
2 changes: 1 addition & 1 deletion ontology/yaml/resources/LIGHTING/entity_types/LGRP.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ LGRP_OS_AWIC:
is_canonical: true
implements:
- LGRP
- OS
- OS
- AWIC
uses:
- group_mode
Loading