doc generated from pipeline

catalog-v001.xml

saref-pipeline.jar

target

documentation/ts_*

The preliminary phase was followed by a kick-off workshop in which the experts of EEBus and E@H presented the details of their individual data models, i.e. EEBus (XSDs) and E@H (UML), and also their common data model, the EEBus & E@H (UML+XSDs) model. 

<figure id="Figure_A.1">

<figure>

        <img data-docx-width="15.52cm" src="diagrams/image9.png" alt="Approach"/>

        <figcaption>Figure A.1: Approach</figcaption>

    </figure>

Since the existing EEBus and E@H data models were expressed in different formats, i.e. XSD and UML, and SAREF4ENER had to be expressed in OWL as an extension of SAREF, these data models were first translated into corresponding OWL versions that could be used as intermediate ontologies towards the creation of SAREF4ENER. The transformations UML  OWL and XSD  OWL were performed manually, but existing tools can be used to automate this step (for example, TopBraid Composer™ Maestro Edition). The outcomes of these transformations were the EEBus (OWL) and E@H (OWL) intermediate ontologies in Figure A.1. The reason to create these two separate intermediate ontologies was practical. The common EEBus & E@H data model is a merged model whose parts could be straightforwardly identified as coming either from the EEBus or the E@H data model. Given that the EEBus and E@H experts were not yet (completely) acquainted with ontologies and OWL, their review process was facilitated by separating the generation of an OWL version in two parts. In this way, these experts could focus on their own part, namely EEBus or E@H, instead of having to deal with a single, large and more complex ontology. Moreover, these intermediate ontologies can be reused individually by the two associations if they decide to make use of an OWL version of their own data model in the future.

!!! alert-info "NOTE:"

!!! alert alert-info "NOTE:"

    TopBraid Composer Maestro Edition™ is an example of a suitable product available commercially. This information is given for the convenience of users of the present document and does not constitute an endorsement by ETSI of this product.

The classes of interest for the use case 1 are `s4ee:Device`, `s4ee:Address`, `s4eeDeviceConnection`, `s4eeDeviceConnectionSetup`, `s4eeNativeSetup`, `s4eeCandidateSetup`, `s4eeScanSetup` and `s4eeJoinModeConfiguration`, as shown in Figure B.1.

<figure id="Figure_B.1">

<figure>

        <img data-docx-width="13.51cm" src="diagrams/image10.png" alt="Configuration "/>

        <figcaption>Figure B.1: Configuration </figcaption>

    </figure>

A `s4eeAppliance` is as a specialization of a `s4eeDevice`and therefore also a specialization of a `saref:Device`, as shown in Figure B.2.

<figure id="Figure_B.2">

<figure>

        <img data-docx-width="13.44cm" src="diagrams/image11.png" alt="Appliance "/>

        <figcaption>Figure B.2: Appliance </figcaption>

    </figure>

    * Each s4eeApplianceParameter is described by s4eeParameterTable, which can be of type s4eeStepParameterTable, s4eePointwiseParameterTable, s4eeBooleanParameterTable or s4eeDateParameterTable. All these tables define the type of permission for a certain parameter (i.e. "read only", "write only" or "read and write") and its unit of measure (saref:isMeasuredIn property). The s4eeStepParameterTable is additionally characterized by at least one minimum value, number of set points and steps. The s4eePointwiseParameterTable is characterized by a point with one or more values (s4eehasPoint min 1 property) described by the s4eeParameterTablePoint class. 

    * Each s4eeApplianceParameter is associated to a state (saref:hasState exactly 1 s4eeApplianceParameterState) which can be used to represent the actual parameter values by means of the s4eeApplianceMonitor class, and to set new values by means of the s4eeApplianceControl class.

<figure id="Figure_B.3">

<figure>

        <img data-docx-width="15.06cm" src="diagrams/image12.png" alt="ApplianceParameter "/>

        <figcaption>Figure B.3: ApplianceParameter </figcaption>

    </figure>

        * The `s4ee:ApplianceParameterSettings` class is characterized by the parameter ID (`s4eeparameterId exactly 1` property) and a number of values for that parameter that are subclass of the `s4eeValue` class, i.e. `s4eeAvoidedValue` (list of not admitted values), `s4ee:DefaultValue` (default value of the parameter), `s4eeMaxValue` (maximum value that the parameter could be set) and `s4eeMinValue` classes (minimum value that the parameter could be set). The `s4eeApplianceParameterSettings` class also has a boolean property to specify whether the settings under consideration are active or not (`s4eeisActive` property).

        * The s4ee`:Expression` class is characterized by a value (`s4eehasValueType exactly 1` property), the parameter ID (`s4ee`parameterId exactly 1 property) that identifies the parameter whose current set point has to be compared, a math operator `s4eemathOperator exactly 1` property) such as "==" , "!=" , ">" , "<" to define set points equal, different, above or below the expression value, and logical connectives (`s4eelogicalConnective min 0` property) such as "AND" and "OR" that could be used to connect different expressions.

<figure id="Figure_B.4">

<figure>

        <img data-docx-width="15.91cm" src="diagrams/image13.png" alt="ApplianceWorkingMode "/>

        <figcaption>Figure B.4: ApplianceWorkingMode </figcaption>

    </figure>

The property `s4eehasValue min 0` `s4eeMaxValue` expresses the maximum value to be used in case of `s4eeaction_3_set_to_MaxValue`.

<figure id="Figure_B.5">

<figure>

        <img data-docx-width="15.91cm" src="diagrams/image14.png" alt="ApplianceCompatibilityAction "/>

        <figcaption>Figure B.5: ApplianceCompatibilityAction </figcaption>

    </figure>

* It has a list of zero or more measurements that represent the actual parameter values for the appliance (`s4eeApplianceMonitor` class in Figure B.6). These measurements can be sent by the appliance automatically as a status notification, or after a specific request from the CEM. The notification contains the information related to the current state of the appliance, i.e. parameter ID, its current value and, optionally, the maximum and minimum values that the parameter can assume.

* It has a list of zero or more control actions (`s4eeApplianceControl` class in Figure B.6), such as command actuation or the setting of working modes and parameters, to control zero or more states of the appliance (`s4eeApplianceParameterState` class). The `s4eeApplianceControl` class also has a boolean property to specify whether the controls under consideration are active or not (`s4eeisActiveyioy` property). 

<figure id="Figure_B.6">

<figure>

        <img data-docx-width="15.91cm" src="diagrams/image15.png" alt="ApplianceMonitor and ApplianceControl "/>

        <figcaption>Figure B.6: ApplianceMonitor and ApplianceControl </figcaption>

    </figure>

* ETSI TS 118 102: "oneM2M; Requirements (oneM2M TS-0002)".

* ETSI, European Commission and TNO: "Study on Semantic Assets for Smart Appliances Interoperability", final report, April 2015.

!!! alert-info "NOTE:"

!!! alert alert-info "NOTE:"

    Available at [https://sites.google.com/site/smartappliancesproject/deliverables](https://sites.google.com/site/smartappliancesproject/deliverables). 

Note that Figure 1 aims at showing a global overview of the main classes of SAREF4ENER and their mutual relations. More details on the different parts of Figure 1 are provided in clause 4.2.2 to clause 4.2.6.

<figure id="Figure_1">

<figure>

        <img data-docx-width="21.31cm" src="diagrams/Overview.png" alt="SAREF4ENER overview"/>

        <figcaption>Figure 1: SAREF4ENER overview</figcaption>

    </figure>

Orange circles represent classes of SAREF4ENER, while faded orange circles represent classes that are reused from other ontologies. Object properties - which are properties between two classes - are denoted by blue rectangles, while datatype properties - which are properties between a class and a data type, such as `xsd:string` or `xsd:dateTime` - are denoted by green rectangles. Faded blue and green rectangles denote object properties and datatype properties that are reused from other ontologies. 

<figure id="Figure_2">

<figure>

        <img data-docx-width="14.22cm" src="diagrams/Hierarchy.png" alt="SAREF4ENER class and property hierarchy "/>

        <figcaption>Figure 2: SAREF4ENER class and property hierarchy </figcaption>

    </figure>

A `s4ener:Device` is a subclass of a `saref:Device`, i.e. it inherits the properties of the more general saref:Device and extends it with additional properties that are specific for SAREF4ENER. The `s4ener:Device` class is shown in Figure 3.

<figure id="Figure_3">

<figure>

        <img data-docx-width="17.00cm" src="diagrams/Device.png" alt="Device "/>

        <figcaption>Figure 3: Device </figcaption>

    </figure>

Table 2 summarizes the properties that characterize a `s4ener:Device`. 

<table id="Table_2" data-docx-preferred-width="7.44cm 9.00cm">

<table data-docx-preferred-width="7.44cm 9.00cm">

  <caption>Table 2: Properties of a Device</caption>

  <tr>

    <th>Property</th>

A `s4ener:PowerProfile` is a subclass of a `saref:Profile`, i.e. it inherits the properties of the more general `saref:Profile` extending it with additional properties that are specific for SAREF4ENER. The `s4ener:PowerProfile` is used by a `s4ener:Device` to expose the power sequences that are potentially relevant for the CEM. A `s4ener:Device` can expose a `s4ener:PowerProfile`, which consists of one or more alternative plans (`s4ener:AlternativesGroup` class). A `s4ener:AlternativesGroup` consists of one or more power sequences (`s4ener:PowerSequence` class), and a `s4ener:PowerSequence` consists of one or more slots (`s4ener:Slot` class). Inversely, a `s4ener:Slot` belongs to only and exactly one `s4ener:PowerSequence`, which, in turn, belongs to only and exactly one `s4ener:AlternativesGroup`, which, in turn, belongs to only and exactly one `s4ener:PowerProfile`. A `s4ener:PowerProfile` belongs to only and exactly one `s4ener:Device`. 

<figure id="Figure_4">

<figure>

        <img data-docx-width="16.97cm" src="diagrams/PowerProfile.png" alt="Power Profile and Alternatives Group"/>

        <figcaption>Figure 4: Power Profile and Alternatives Group</figcaption>

    </figure>

Table 3 summarizes the properties that characterize a `s4ener:PowerProfile` and an `s4ener:AternativesGroup`. 

<table id="Table_3" data-docx-preferred-width="7.69cm 8.48cm">

<table data-docx-preferred-width="7.69cm 8.48cm">

  <caption>Table 3: Properties of a Power Profile and an AlternativesGroup</caption>

  <tr>

    <th>Property</th>

The `s4ener:AlternativesGroup` described in clause 4.2.3 consists of one or more power sequences (`s4ener:PowerSequence` class) and, inversely, a `s4ener:PowerSequence` belongs to only and exactly one `s4ener:AlternativesGroup`. Figure 5 shows the details of the `s4ener:PowerSequence` class. 

<figure id="Figure_5">

<figure>

        <img data-docx-width="16.97cm" src="diagrams/PowerSequence.png" alt="Power Sequence"/>

        <figcaption>Figure 5: Power Sequence</figcaption>

    </figure>

Table 4 summarizes the properties that characterize a `s4ener:PowerSequence`. 

<table id="Table_4" data-docx-preferred-width="7.69cm 8.48cm">

<table data-docx-preferred-width="7.69cm 8.48cm">

  <caption>Table 4: Properties of the PowerSequence </caption>

  <tr>

    <th>Property</th>

The `s4ener:PowerSequence` described in clause 4.2.4 consists of one or more slots (`s4ener:Slot` class) and, inversely, a `s4ener:Slot belongs` to only and exactly one `s4ener:PowerSequence`. Figure 6 shows the details of the s4ener:Slot class. 

<figure id="Figure_6">

<figure>

        <img data-docx-width="14.96cm" src="diagrams/Slot.png" alt="Slot"/>

        <figcaption>Figure 6: Slot</figcaption>

    </figure>

Table 5 summarizes the properties that characterize a `s4ener:Slot`.

<table id="Table_5" data-docx-preferred-width="7.69cm 8.48cm">

<table data-docx-preferred-width="7.69cm 8.48cm">

  <caption>Table 5: Properties of a Slot </caption>

  <tr>

    <th>Property</th>

This clause presents the part of SAREF4ENER that defines how to model events used in, for example, a direct load management and power curtailing scenarios (i.e. use case 4). The classes of interest are `s4ener:LoadControlEventData`, `s4ener:LoadControlEventAction`, `s4ener:LoadControlStateData` and `s4ener:LoadControlState`, as shown in Figure 7. 

<figure id="Figure_7">

<figure>

        <img data-docx-width="16.97cm" src="diagrams/LoadControl.png" alt="Load Control "/>

        <figcaption>Figure 7: Load Control </figcaption>

    </figure>

### Normative references

# References

## Normative references

* <a id="[0]">[0]</a> [ETSI TS 103 410-1 (V1.1.2)](https://www.etsi.org/deliver/etsi_ts/103400_103499/10341001/01.01.01_60/ts_10341001v010102p.pdf): "SmartM2M;; Extension to SAREF; Part 1: Energy Domain".

* <a id="[1]">[1]</a>	EEBus SPINE.

!!! alert-info "NOTE:"

!!! alert alert-info "NOTE:"

    Available at [https://www.eebus.org/en/specifications/](https://www.eebus.org/en/specifications/). 

* <a id="[2]">[2]</a>	ETSI TS 103 264 (V3.1.1): "SmartM2M; Smart Applications; Reference Ontology and oneM2M Mapping".

### Informative references

## Informative references

* <a id="[i.1]">[i.1]</a>	TNO, EEBus, Energy@Home: "SAREF4EE".

!!! alert-info "NOTE:"

!!! alert alert-info "NOTE:"

    Available at [https://w3id.org/saref4ee](https://w3id.org/saref4ee). 

* <a id="[i.2]">[i.2]</a>	Energy@home Data Model, v2.1, October 2015.

!!! alert-info "NOTE:"

!!! alert alert-info "NOTE:"

    Available at [http://www.energy-home.it/Documents/Technical%20Specifications/E@h_data_model_v2.1.pdf](http://www.energy-home.it/Documents/Technical%20Specifications/E@h_data_model_v2.1.pdf). 

* <a id="[i.3]">[i.3]</a>	IEC TR 62746-2:2015: "Systems interface between customer energy management system and the power management system - Part 2: Use cases and requirements".

!!! alert-info "NOTE:"

!!! alert alert-info "NOTE:"

    Available at [https://webstore.iec.ch/publication/22279](https://webstore.iec.ch/publication/22279). 

* <a id="[i.4]">[i.4]</a>	ETSI TR 103 411: "SmartM2M Smart Appliances SAREF extension investigation".