Unverified Commit 3901f416 authored by Maxime Lefrançois's avatar Maxime Lefrançois
Browse files

documentation generated from TS

parent 06cfb997
Loading
Loading
Loading
Loading
+18 −0
Original line number Diff line number Diff line

For the purposes of the present document, the following abbreviations apply:

* ASME: American Society of Mechanical Engineers
* OWL: Ontology Web Language
* OWL-DL: Ontology Web Language - Description Logics
* RDF: Resource Description Framework
* RDF-S: Resource Description Framework - Schema 
* SAREF: Smart Applications REFerence ontology
* SAREF4LIFT: SAREF extension for the Smart LIFTs domain
* SOS: Save Our Souls

!!! alert-info "NOTE:"
    SOS was chosen to signify a distress signal. In Morse code, SOS is signified by three dots, three dashes, three dots.

* STF: Specialist Task Force
* UML: Unified Modelling Language
* URI: Uniform Resource Identifier
 No newline at end of file
+11 −5
Original line number Diff line number Diff line
SAREF4LIFT is an ontology that extends SAREF for the Smart Lifts domain. This SAREF extension is based on a limited set of use cases and existing data models identified within available initiatives that was detailed in previous documents ETSI TR 103 546 [[i.1]](#[i.1]) and ETSI TS 103 735 [[i.2]](#[i.2]). The development of SAREF4LIFT has been conducted in the context of the <a href="https://portal.etsi.org/STF/STFs/STF-HomePages/STF602">STF 602</a>, which was established with the goal of creating SAREF extension for the domain mentioned above, i.e. Smart Lifts. This work has been developed in close collaboration with the industrial world and alliances.

One of the tasks of STF 602 consists of specifying and producing the extension of SAREF for the aforementioned domain based on the requirements resulting from previous initiatives. The related initiatives and use cases considered for the development of the SAREF4LIFT extension are the ones reported previously in ETSI TR 103 546 [[i.1]](#[i.1]) and ETSI TS 103 735 [[i.2]](#[i.2]). Such related initiatives and use cases are not repeated in this document. Hence, the reader can rely on those references for further details.
# SAREF extension for the Smart Lifts domain

The prefixes and namespaces used in SAREF4LIFT and in the present document are listed in [the Namespace Declarations section](#namespacedeclarations)

The present document is a technical specification of SAREF4LIFT, an extension of SAREF for the Smart Lifts domain. This SAREF extension will be based on a limited set of use cases and existing data models identified within available initiatives that was detailed in previous documents ETSI TR 103 546 [i.1] and ETSI TS 103 735 [i.2]. The work conducted in the present document has been developed in the context of the STF 602, which was established with the goal of creating SAREF extension for the domain mentioned above, i.e. Smart Lifts. This work has been developed in close collaboration with the industrial world and alliances.


One of the tasks of STF 602 consists of specifying and producing the extension of SAREF for the aforementioned domain based on the requirements resulting from previous initiatives. The present document focuses on the extension of SAREF for the Smart Lifts domain. The present document sets the ontological requirements of the stable semantic model resulting in a new SAREF ontology extension for Smart Lifts, called SAREF4LIFT.


The related initiatives and use cases considered for the development of the SAREF4LIFT extension are the ones reported previously in ETSI TR 103 546 [i.1] and ETSI TS 103 735 [i.2]. Such related initiatives and use cases are not repeated in the present document. Hence, the reader can rely on those references for further details.
+81 −0
Original line number Diff line number Diff line

# Change History

<table data-docx-preferred-width="2.76cm 1.43cm 12.69cm">
  <tr>
    <th>Date</th>
    <th>Version</th>
    <th>Information about changes</th>
  </tr>
  <tr>
    <td>2021-02-04</td>
    <td style="text-align:center">0.0.1</td>
    <td>First skeleton.</td>
  </tr>
  <tr>
    <td>2021-02-09</td>
    <td style="text-align:center">0.0.2</td>
    <td>First list of requirements.</td>
  </tr>
  <tr>
    <td>2021-02-17</td>
    <td style="text-align:center">0.0.3</td>
    <td>Refined list of requirements.</td>
  </tr>
  <tr>
    <td>2021-03-09</td>
    <td style="text-align:center">0.0.4</td>
    <td>Finalized clauses 2 and 3. First draft of the extension description.</td>
  </tr>
  <tr>
    <td>2021-03-10</td>
    <td style="text-align:center">0.0.5</td>
    <td>Added description of the SAREF4LIFT extensions and diagrams.</td>
  </tr>
  <tr>
    <td>2021-03-13</td>
    <td style="text-align:center">0.0.6</td>
    <td>Finalized description of the SAREF4LIFT extensions and diagrams.</td>
  </tr>
  <tr>
    <td>2021-04-01</td>
    <td style="text-align:center">0.0.7</td>
    <td>Added examples and observations.</td>
  </tr>
  <tr>
    <td>2021-04-10</td>
    <td style="text-align:center">0.0.8</td>
    <td>First stable draft release.</td>
  </tr>
  <tr>
    <td>2021-04-28</td>
    <td style="text-align:center">0.0.9</td>
    <td>Added new examples.</td>
  </tr>
  <tr>
    <td>2021-05-15</td>
    <td style="text-align:center">0.1.0</td>
    <td>Second stable draft release including fixes discussed during the fourth STF602 meeting.</td>
  </tr>
  <tr>
    <td>2021-05-25</td>
    <td style="text-align:center">0.1.1</td>
    <td>Update after ETSI forge merge request #6 March 23.</td>
  </tr>
  <tr>
    <td>2021-06-16</td>
    <td style="text-align:center">1.1.1</td>
    <td>Technical Officer review for EditHelp publication pre-processing.</td>
  </tr>
  <tr>
    <td>2021-07-05</td>
    <td style="text-align:center">1.1.1</td>
    <td>Final Rapporteur and Technical Officer changes requested by ETSI <strong><em>editHelp</em></strong>! </td>
  </tr>
</table>





documentation/description.html

deleted100644 → 0
+0 −113
Original line number Diff line number Diff line
<p>SAREF4LIFT has been specified and formalised by investigating related resources in the smart lifts domain, as reported in ETSI TR 103 546 <a href="#[i.1]">[i.1]</a> and ETSI TS 103 735 <a href="#[i.2]">[i.2]</a>. Therefore, SAREF4LIFT shall both:</p>

<ul>
  <li>Allow the implementation of a limited set of related use cases already identified in <a href="#[i.1]">[i.1]</a>.</li>
  <li>Fulfil the requirements provided in Clause 5, mainly the ontological ones that were mostly taken as input for the ontology specification.</li>
</ul>

<p>SAREF4LIFT is an OWL-DL ontology. For embedded semantic analytics purposes, SAREF4LIFT shall be designed using the modularity principle and can thus be mainly described by a set of knowledge modules. All these SAREF4LIFT modules are fully detailed below. </p>


<h3>General overview</h3>

<p><a href="#Figure_1">Figure 1</a> presents the high level view of the envisioned model of SAREF4LIFT ontology. In <a href="#Figure_1">Figure 1</a>, classes directly imported from SAREF ontology are in light orange, classes directly imported from other SAREF extension ontologies are in green. While, classes developed for SAREF4LIFT are in blue.</p>

<figure>
  <a href="diagrams/TS103735_Clause_6_2_1_General-Overview.png"><img src="diagrams/TS103735_Clause_6_2_1_General-Overview.png" alt="SAREF4LIFT overview."/></a>
  <figcaption id="Figure_1">Figure 1: SAREF4LIFT overview.</figcaption>
</figure>

<p>Within <a href="#Figure_1">Figure 1</a>, as well as within all the figures that are depicted in this documentation, the following conventions are used: </p>

<ul>
  <li>Arrows are used to represent properties between classes and to represent some RDF, RDF-S and OWL constructs, more precisely:</li>
  <ul>
    <li>Plain arrows with white triangles represent the rdfs:subClassOf relation between two classes. The origin of the arrow is the class to be declared as subclass of the class at the destination of the arrow.</li>
    <li>Dashed arrows between two classes indicate a local restriction in the origin class, i.e. that the object property can be instantiated between the classes in the origin and the destination of the arrow. The identifier of the object property is indicated within the arrow.</li>
  </ul>
  <li>Datatype properties are denoted by rectangles attached to the classes, in an UML-oriented way. Dashed boxes represent local restrictions in the class, i.e. datatype properties that can be applied to the class they are attached to.</li>
  <li>Individuals are denoted by rectangles in which the identifier is underlined.</li>
</ul>

<p>SAREF4LIFT is an OWL-DL ontology and shall be designed using the modularity principle (see ETSI TR 103 510 <a href="#[i.4]">[i.4]</a>) and can thus be mainly described by the following self-contained knowledge modules:</p>

<ul>
  <li><strong><a href="#Systems_and_connections">Systems and connections</a>.</strong> This module defines the different systems modelled within a smart lift environment. A system is described as a component virtually isolated from the environment, whose behaviour and interactions with the environment are specifically defined. Systems can be connected to other systems. Connected systems interact in some ways. Systems can also have subsystems. Properties of subsystems somehow contribute to the properties of the supersystem.</li>
  <li><strong><a href="#Devices_and_commands">Devices and commands</a>.</strong> This module defines the devices included within a smart lift. A device is defined as a tangible object designed to accomplish a particular task. In order to accomplish this task, the device performs one or more functions. The root of this branch (<a href="https://saref.etsi.org/core/Device">saref:Device</a>) is inherited directly from the SAREF Core ontology. Also, this module defines commands supported by the defined smart lift. A command is defined as a directive that a device should support to perform a certain function. A command may act upon a state, but does not necessarily act upon a state. For example, the ON command acts upon the ON/OFF state, but the GET command does not act upon any state, it simply gives a directive to retrieve a certain value. The root of this branch (<a href="https://saref.etsi.org/core/Command">saref:Command</a>) is inherited directly from the SAREF Core ontology.</li>
  <li><strong><a href="#States_and_measurements">States and measurements</a>.</strong> This module defines states that features of interest in a smart lift installation can be found in, and measurements that can be made about features of interest in a smart lift.</li>
  <li><strong><a href="#Signals">Signals</a>.</strong> This module describes the types of signals supported by a smart lift. Four type of signals have been identified:, car signal (<a href="#s4lift:AlarmSignal">s4lift:AlarmSignal</a>), fault signal (<a href="#s4lift:FaultSignal">s4lift:FaultSignal</a>), status signal (<a href="#s4lift:StatusSignal">s4lift:StatusSignal</a>), and statistic signal (<a href="#s4lift:StatisticSignal">s4lift:StatisticSignal</a>). The <a href="#Signal">section on Signals</a> provides a complete taxonomy of supported signals with respect to the ones reported in <a href="#Figure_1">Figure 1</a>.</li>
</ul>

<p>Besides the four module described above, the SAREF4LIFT extension defines also two new property types (<a href="#s4lift:Load">s4lift:Load</a> and <a href="#s4lift:Voltage">s4lift:Voltage</a>) defining the load in the smart lift car and the electric voltage of some electric power system.</p>

<h3 id="Systems_and_connections">Systems and connections</h3>

<p>This module specializes the SAREF4SYST ontology pattern for the Smart Lift domain.</p>

<p>A Smart Lift system can be defined as a <a href="https://saref.etsi.org/saref4syst/System">s4syst:System</a> made by different components. This module defines the subcomponents that are part of Smart Lift. In particular, two subcomponents are denoted: the <a href="#s4lift:SmartLiftEdgeComponent">s4lift:SmartLiftEdgeComponent</a> and the <a href="#s4lift:SmartLiftEdgeControlUnit">s4lift:SmartLiftEdgeControlUnit</a>. The former is dedicated to the hosting of smart lift additional modules in the case that they are not hosted directly in the <a href="#s4lift:SmartLiftEdgeControlUnit">s4lift:SmartLiftEdgeControlUnit</a>. An example could be the case of an additional earthquake sensor added after the lift deployment and not controlled by the <a href="#s4lift:SmartLiftEdgeControlUnit">s4lift:SmartLiftEdgeControlUnit</a>.
The latter is the main element of a Smart Lift installation and it is typically associated with the lift control cabinet.</p>

<p>A <a href="#s4lift:SmartLiftInstallation">s4lift:SmartLiftInstallation</a> corresponds to a single lift, with all its elements. Such a concept is equipped with the list of properties shown in Figure 2. Seven types of installations are considered relevant for this extension: namely <a href="#s4lift:AccessibleGoodsOnlySmartLift">s4lift:AccessibleGoodsOnlySmartLift</a> as per EN 81-31 <a href="[2]">[2]</a>, <a href="#s4lift:AccessibleGoodsOnlySmartLift">s4lift:AccessibleGoodsOnlySmartLift</a> as per EN 81-72 <a href="[3]">[3]</a>, <a href="#s4lift:GoodsSmartLift">s4lift:GoodsSmartLift</a>, and <a href="#s4lift:MachineRoomLessSmartLift">s4lift:MachineRoomLessSmartLift</a>, <a href="#s4lift:PassengerAndGoodsPassengerSmartLift">s4lift:PassengerAndGoodsPassengerSmartLift</a> as per EN 81-20 <a href="[4]">[4]</a>, <a href="#s4lift:SmartLiftWithoutEmergencyCallSupport">s4lift:SmartLiftWithoutEmergencyCallSupport</a>, <a href="#s4lift:VerticalSmartLiftingPlatform">s4lift:VerticalSmartLiftingPlatform</a> as per EN 81-41 <a href="[5]">[5]</a>. All these concepts represent a type of smart lift that can be instantiated by the ontology.</p>

<p>A <a href="#s4lift:SmartLiftGroup">s4lift:SmartLiftGroup</a> represents the correlation of multiple Smart Lifts Installation and it is supported by the introduction of a Smart Lift Group identifier common each Smart Lifts Installation belonging to the same Smart Lift Group. Such kind of installations usually presents control units connected one each other to coordinate the movement and position of the different lifts, where the common commands (e.g. the call buttons) are given to one of these control units that acts as a principal master and coordinates the other installations or is composed by peer installations that coordinates one each other.</p>

<p>A <a href="#s4lift:SmartLiftCar">s4lift:SmartLiftCar</a> represents the car of a Smart Lift. A <a href="#s4lift:SmartLiftInstallation">s4lift:SmartLiftInstallation</a> usually contains different <a href="#s4lift:CarStopSpaces">s4lift:CarStopSpaces</a> serving different spaces of different floors at <a href="#s4lift:Smart">s4lift:Smart</a> LiftCarService. A <a href="#s4lift:SmartLiftCar">s4lift:SmartLiftCar</a> can connect to some <a href="https://saref.etsi.org/saref4bldg/BuildingSpace">s4bldg:BuildingSpace</a> through some <a href="#s4lift:SmartLiftCarService">s4lift:SmartLiftCarService</a> at some <a href="#s4lift:DoorConnectionPoint">s4lift:DoorConnectionPoint</a>.  </p>

<p>A <a href="#s4lift:Network">s4lift:Network</a> is the class of communication networks. Systems can connect to other networks through a potential <a href="#s4lift:NetworkAccess">s4lift:NetworkAccess</a> connection.</p>


<figure>
  <a href="diagrams/TS103735_Clause_6_2_2_SystemsAndConnections.png"><img src="diagrams/TS103735_Clause_6_2_2_SystemsAndConnections.png" alt="Systems and connections model."/></a>
  <figcaption id="Figure_2">Figure 2: Systems and connections model.</figcaption>
</figure>


<h3 id="Devices_and_commands">Devices and commands</h3>

<p>This model specifies the list of commands that is considered relevant for the smart lift domain. Six new defined commands that are subsumed by the saref:Command concept that can be triggered, in turn, by a <a href="https://saref.etsi.org/core/Function">saref:Function</a> as presented in <a href="#Figure_3">Figure 3</a>:</p>

<ul>
  <li><a href="#s4lift:MainBoardResetCommand">s4lift:MainBoardResetCommand</a> defines the command for resetting the main board of a smart lift;</li>
  <li><a href="#s4lift:SendCarToSpecificServiceCommand">s4lift:SendCarToSpecificServiceCommand</a> defines the internal command for sending the car to a specific service;</li>
  <li><a href="#s4lift:SetOutOfServiceCommand">s4lift:SetOutOfServiceCommand</a> defines the command for putting the smart lift in out of service mode;</li>
  <li><a href="#s4lift:SetRealTimeModeCommand">s4lift:SetRealTimeModeCommand</a> defines the command for putting the smart lift in out of service mode;</li>
  <li><a href="#s4lift:TestEmergencyNumberCommand">s4lift:TestEmergencyNumberCommand</a> defines the command for testing if the emergency number is working;</li>
  <li><a href="#s4lift:TestRideCommand">s4lift:TestRideCommand</a> defines the command for performing a test ride of a smart lift.</li>
</ul>

<figure>
  <a href="diagrams/TS103735_Clause_6_2_3_DevicesAndCommands.png"><img src="diagrams/TS103735_Clause_6_2_3_DevicesAndCommands.png" alt="Devices and commands model."/></a>
  <figcaption id="Figure_3">Figure 3: Devices and commands model.</figcaption>
</figure>


<h3 id="States_and_measurements">States and measurements</h3>

<p>This module defines states that features of interest in a smart lift installation can be found in, and measurements that can be made about features of interest in a smart lift.</p>


<figure>
  <a href="diagrams/TS103735_Clause_6_2_4_StatesAndMeasurements.png"><img src="diagrams/TS103735_Clause_6_2_4_StatesAndMeasurements.png" alt="States and measurements model."/></a>
  <figcaption id="Figure_4">Figure 4: States and measurements model.</figcaption>
</figure>


<h3 id="Signals">Signals</h3>

<p>This module describes the types of signals that can be read from a smart lift console. <a href="#Figure_5">Figure 5</a> shows the taxonomy of the relevant types of signals foreseen within this extension.</p>

<p>It is possible to observe a set of four main types of signals:</p>

<ul>
  <li><a href="#s4lift:AlarmSignal">s4lift:AlarmSignal</a>: this defines high priority signals used to attract the operator’s attention to important deviations or abnormal events in system operation.</li>
  <li><a href="#s4lift:StatisticSignal">s4lift:StatisticSignal</a>: such signals convey (<a href="#s4lift:conveys">s4lift:conveys</a>) a <a href="#s4lift:StatisticsMeasurement">s4lift:StatisticsMeasurement</a> about the smart lift usage.</li>
  <li><a href="#s4lift:FaultSignal">s4lift:FaultSignal</a>: these are the signals sent by the smart lift car about its overall status. This concept subsumes three further concepts grouping likewise car signal types.</li>
  <li><a href="#s4lift:StatusSignal">s4lift:StatusSignal</a>: these are signals that convey (<a href="#s4lift:conveys">s4lift:conveys</a>) a saref:State of a feature of interest.</li>
</ul>

<p>Descendants of the <a href="#s4lift:Signal">s4lift:Signal</a> inherit the <a href="https://saref.etsi.org/core/hasTimestamp">saref:hasTimestamp</a>,  <a href="https://saref.etsi.org/core/isAbout">saref:isAbout</a>, and <a href="#s4lift:conveys">s4lift:conveys</a> properties defining the timestamp when the signal has been generated, the features of interest that the signal is about, and the states or measurements conveyed, respectively.</p>

<figure>
  <a href="diagrams/TS103735_Clause_6_2_5_Signals.png"><img src="diagrams/TS103735_Clause_6_2_5_Signals.png" alt="Signals model."/></a>
  <figcaption id="Figure_5">Figure 5: Signals model.</figcaption>
</figure>
Loading