diff --git a/_toc.yml b/_toc.yml index cba60c4d..539824b9 100644 --- a/_toc.yml +++ b/_toc.yml @@ -14,6 +14,7 @@ parts: - file: explanation/closed_world_assumption.md - file: explanation/heat_transfer_equipment.md - file: explanation/medium_mixtures.md + - file: explanation/modeling_electrical_service.md - file: explanation/sensors_and_properties.md - caption: Tutorials chapters: diff --git a/explanation/definitions.md b/explanation/definitions.md index ee779b38..575737fc 100644 --- a/explanation/definitions.md +++ b/explanation/definitions.md @@ -49,4 +49,25 @@ The 223 standard defines a hierarchy of classes used to define the entities with - **Enumerations:** The standard uses enumerations to convey groups of useful values for describing attributes of Properties, Equipment, and other things in the model. For example, the enumeration `Role-Cooling` describes that the equipment in question provides cooling. - - **FunctionBlock:** Is used to model transfer and/or transformation of information (e.g. control algorithms). It has relations to input properties and output properties, that represent input and output data. The actual algorithms that perform the transformations are not described in 223, and can be described using standard 231. \ No newline at end of file + - **FunctionBlock:** Is used to model transfer and/or transformation of information (e.g. control algorithms). It has relations to input properties and output properties, that represent input and output data. The actual algorithms that perform the transformations are not described in 223, and can be described using standard 231. + + ## 223 Top Meta Level Partitioning + + Disclaimer: Most model developers won't need to read this section. + + If you really need to understand the meta level model, the figure shown below should help. + - All s223 classes are instances (rdf:type) of s223:Class, except for s223:Class itself. + - All s223 relations are instances of s223:Relation. + - s223:Class and s223:Relation are subclasses of s223:Concept. + - All s223 classes are also direct or indirect subclasses of s223:Concept. + + A developer can extend the 223 standard with their own subclasses or subproperties. Those extensions should not be declared as instances of s223:Class or s223:Relation. In this way, any user can distinguish what classes and properties used in a model are part of the 223 standard, and which are extensions. + + ```{image} images/explanation-top-level-metaclasses.png +:align: center +:width: 700px +``` + +
+Figure 1. Partial view of meta level classes for Standard 223 entities +
diff --git a/guides/images/guides-110V-60Hz-single-phase-structure.png b/explanation/images/explanation-110V-60Hz-single-phase-structure.png similarity index 100% rename from guides/images/guides-110V-60Hz-single-phase-structure.png rename to explanation/images/explanation-110V-60Hz-single-phase-structure.png diff --git a/guides/images/guides-240V-60Hz-three-phase-structure.png b/explanation/images/explanation-240V-60Hz-three-phase-structure.png similarity index 100% rename from guides/images/guides-240V-60Hz-three-phase-structure.png rename to explanation/images/explanation-240V-60Hz-three-phase-structure.png diff --git a/guides/images/guides-3-phase-query.png b/explanation/images/explanation-3-phase-query.png similarity index 100% rename from guides/images/guides-3-phase-query.png rename to explanation/images/explanation-3-phase-query.png diff --git a/guides/images/guides-AC-service-example.png b/explanation/images/explanation-AC-service-example.png similarity index 100% rename from guides/images/guides-AC-service-example.png rename to explanation/images/explanation-AC-service-example.png diff --git a/guides/images/guides-AC-service-excerpt.png b/explanation/images/explanation-AC-service-excerpt.png similarity index 100% rename from guides/images/guides-AC-service-excerpt.png rename to explanation/images/explanation-AC-service-excerpt.png diff --git a/guides/images/guides-HighLegDelta.png b/explanation/images/explanation-HighLegDelta.png similarity index 100% rename from guides/images/guides-HighLegDelta.png rename to explanation/images/explanation-HighLegDelta.png diff --git a/explanation/images/explanation-top-level-metaclasses.png b/explanation/images/explanation-top-level-metaclasses.png new file mode 100644 index 00000000..a9e3aa43 Binary files /dev/null and b/explanation/images/explanation-top-level-metaclasses.png differ diff --git a/guides/modeling-electricity.md b/explanation/modeling_electrical_service.md similarity index 77% rename from guides/modeling-electricity.md rename to explanation/modeling_electrical_service.md index a9bb8b9f..a01258b0 100644 --- a/guides/modeling-electricity.md +++ b/explanation/modeling_electrical_service.md @@ -1,14 +1,14 @@ -# Modeling Electricity +# Modeling Electrical Service -This guide shows the simple way to specify electrical characteristics by specifying the electrical service on a wire or circuit, and then goes into more detail about what is "under the hood" in terms of modeling it. +This section shows the simple way to specify electrical characteristics by specifying the electrical service on a wire or circuit, and then goes into more detail about what is "under the hood" in terms of modeling it. ## Using Predefined Electrical Service The 223 standard comes with a predefined vocabulary of common electrical service, so the easiest way to model is simply to pick the appropriate service from the controlled vocabulary. Shown below is a small excerpt of available AC electrical service. -![ACServiceExcerpt](images/guides-AC-service-excerpt.png) +![ACServiceExcerpt](images/explanation-AC-service-excerpt.png) -There is a naming convention to help the human reader in understanding each option, but note that later in this guide we will show how all the +There is a naming convention to help the human reader in understanding each option, but note that later in this Explanation we will show how all the properties of the service are queryable without resorting to parsing the name of the service. With that disclaimer, a human reader can interpret the service s223:AC-120VLN-1Ph-60Hz to mean "AC electricity, carrying 120 volts between Line and Neutral, single-phase, at 60Hz frequency". @@ -16,33 +16,33 @@ A more complex example is s223:AC-240VLL-208VLN-120VLN-3Ph-60Hz, meaning "three- Assuming your desired electrical service is listed in the vocabulary, the simplest way to model the electricity in the building is to use the s223:hasMedium relation, as shown below: -![ACServiceExample](images/guides-AC-service-example.png) +![ACServiceExample](images/explanation-AC-service-example.png) ## High-Leg-Delta Distribution Panel Here's a diagram of a "High-Leg-Delta" distribution panel, which provides several different voltages and phases, and a diagram of key parts of the resulting model. ... -![HighLegDeltaModel](images/guides-HighLegDelta.png) +![HighLegDeltaModel](images/explanation-HighLegDelta.png) ## The Structure of the Electricity Vocabulary Entries Since 223 is a semantic standard, relying on the naming convention is not sufficient to allow for querying of a model. For those who need to go deeper, the following section explains the structure of each of the vocabulary entries for electricity. Shown below is a diagram of that structure: -![110Vstructure](images/guides-110V-60Hz-single-phase-structure.png) +![110Vstructure](images/explanation-110V-60Hz-single-phase-structure.png) Following the relations, you can see that it is possible to find the numerical values for the frequency, number of phases, and voltage for the service. Note that the semantic model never depends on the names of the entities to provide this information, so that numerical comparisons and calculations are possible. Here is that more complex example shown with its full structure: -![240Vstructure](images/guides-240V-60Hz-three-phase-structure.png) +![240Vstructure](images/explanation-240V-60Hz-three-phase-structure.png) ## Querying a Model for Electrical Characteristics The power of explicitly modeling all the characteristics of the electricity can be seen with some query examples. Here is a query to find in the vocabulary all electrical service that is 3-phase, with a line-neutral voltage of 120V: -![3-phase-query](images/guides-3-phase-query.png) +![3-phase-query](images/explanation-3-phase-query.png) In a similar way, one can query a specific building model to find the electrical service(s) in use and drill down to determine the voltages and other properties that are present.