Commit 747306fe authored by Maxime Lefrançois's avatar Maxime Lefrançois
Browse files

Merge branch 'documentation' into 'develop-v1.1.1' 

Added documentation with examples

Closes #1

See merge request SAREF/saref4wear!1
parents bf19dd6d 984d2cab

documentation/description.html

0 → 100644
+123 −0
Original line number Original line Diff line number Diff line 
<p>This document presents the implementation of the SAREF extension for the wearables domain (SAREF4WEAR) which based on a limited set of use cases and from available existing data models. This work has been developed in the context of the <a href="https://portal.etsi.org/STF/STFs/STF-HomePages/STF566">STF 566</a> which was established with the goal to create SAREF extensions for the domains of automotive, eHealth and ageing well, wearables, and water.</p>





<h3>General overview</h3>



<p><a href="#Figure_1">Figure 1</a> presents an overview of the classes and the properties included in the SAREF4WEAR extension.</p>



<figure>

  <a href="diagrams/SAREF4WEAR Overview.png"><img src="diagrams/SAREF4WEAR Overview.png" alt="SAREF4WEAR overview"/></a>

  <figcaption id="Figure_1">Figure 1: SAREF4WEA overview</figcaption>

</figure>





<h3>Measurement</h3>



<p>As it can be observed in <a href="#Figure_2">Figure 2</a>, the modelling of measurements in the SAREF4WEAR ontology mostly relies on the measurement model proposed in SAREF.</p>



<p>The SAREF4WEAR extension requires to be able to represent those devices that measure a certain feature of interest (and those features of interest that are measured by a device) independently of having measures from which this relationship could be inferred. Because of this, in this extension we have created four new properties to relate <a href="https://saref.etsi.org/core/Device">saref:Device</a> and <a href="https://saref.etsi.org/core/FeatureOfInterest">saref:FeatureOfInterest</a>: <a href="#s4wear:featureIsMeasuredByDevice">s4wear:featureIsMeasuredByDevice</a>, <a href="#s4wear:featureIsControlledByDevice">s4wear:featureIsControlledByDevice</a>, <a href="#s4wear:measuresFeature">s4wear:measuresFeature</a>, and <a href="#s4wear:controlsFeature">s4wear:controlsFeature</a>.</p>



<figure>

  <a href="diagrams/SAREF4WEAR Measurement.png"><img src="diagrams/SAREF4WEAR Measurement.png" alt="Measurement model"/></a>

  <figcaption id="Figure_2">Figure 2: Measurement model</figcaption>

</figure>





<h3>Feature of interest</h3>



<p>The Feature of Interest module describes the different actors that can be equipped with a Wearable device, as presented in <a href="#Figure_3">Figure 3</a>. We foresee different types of actors: living organisms (<a href="#s4wear:LivingOrganism">s4wear:LivingOrganism</a>) and software (<a href="#s4wear:Software">s4wear:Software</a>). There is also a wearer class (<a href="#s4wear:Wearer">s4wear:Wearer</a>) to describe those living organisms that wear some wearable.</p>



<p>The <a href="#s4wear:LivingOrganism">s4wear:LivingOrganism</a> concept represents any living being that can be equipped with a Wearable device. The <a href="#s4wear:Software">s4wear:Software</a> concept represents a program that can be linked with a <a href="#s4wear:Wearable">s4wear:Wearable</a> especially for acquiring information.</p>



<p>The <a href="#s4wear:Wearer">s4wear:Wearer</a> concept defines any <a href="https://saref.etsi.org/core/LivingOrganism">saref:LivingOrganism</a> for which the <a href="#s4wear:featureIsMeasuredByDevice">s4wear:featureIsMeasuredByDevice</a> property subsists, i.e., the <a href="#s4wear:Wearable">s4wear:Wearable</a> device transmits information related to the connected <a href="https://saref.etsi.org/core/LivingOrganism">saref:LivingOrganism</a>.</p>



<p>The <a href="#s4wear:User">s4wear:User</a> concept refers to a <a href="https://saref.etsi.org/core/FeatureOfInterest">saref:FeatureOfInterest</a> for which the <a href="#s4wear:interactsWith">s4wear:interactsWith</a> relationship with a <a href="#s4wear:Wearable">s4wear:Wearable</a> individual exists.</p>



<figure>

  <a href="diagrams/SAREF4WEAR Feature of interest.png"><img src="diagrams/SAREF4WEAR Feature of interest.png" alt="Feature of interest model"/></a>

  <figcaption id="Figure_3">Figure 3: Feature of interest model</figcaption>

</figure>





<h3>Wearable</h3>



<p>SAREF4WEAR defines the <a href="#s4wear:Wearable">s4wear:Wearable</a> abstract concept representing a <a href="https://saref.etsi.org/core/Device">saref:Device</a> having the capability of being wore by a <a href="#s4wear:Wearer">s4wear:Wearer</a>.</p>

 

<p>As depicted in <a href="#Figure_4">Figure 4</a>, the <a href="#s4wear:Wearable">s4wear:Wearable</a> class subsumes three further concepts with information related to the position of the <a href="#s4wear:Wearable">s4wear:Wearable</a> with respect to its <a href="#s4wear:Wearer">s4wear:Wearer</a>:

<ul>

<li><a href="#s4wear:InBodyWearable">s4wear:InBodyWearable</a> describing a <a href="#s4wear:Wearable">s4wear:Wearable</a> device positioned inside the body of the <a href="#s4wear:Wearer">s4wear:Wearer</a>;</li>

<li><a href="#s4wear:NearBodyWearable">s4wear:NearBodyWearable</a> describing a <a href="#s4wear:Wearable">s4wear:Wearable</a> device positioned near the body of the <a href="#s4wear:Wearer">s4wear:Wearer</a>;</li>

<li><a href="#s4wear:OnBodyWearable">s4wear:OnBodyWearable</a> describing a <a href="#s4wear:Wearable">s4wear:Wearable</a> device positioned on the body (i.e. direct contact) of the <a href="#s4wear:Wearer">s4wear:Wearer</a>.</li>

</ul>

</p>



<p>The latter is furtherly specified with the <a href="#s4wear:TextileBasedWearable">s4wear:TextileBasedWearable</a> concept describing <a href="#s4wear:Wearable">s4wear:Wearable</a> devices integrated into textile products directly.</p>



<p>The extension also allows to define for a wearable which are the policies (<a href="#s4wear:Policy">s4wear:Policy</a>) followed by it by means of the <a href="#s4wear:followsPolicy">s4wear:followsPolicy</a> property.</p>



<p>Besides, the capabilities of a wearable under specific conditions (ssn-system:SystemCapability), such as its precision or accuracy, can be represented using the ssn-system:hasSystemCapability property.</p>

 

<figure>

  <a href="diagrams/SAREF4WEAR Wearable.png"><img src="diagrams/SAREF4WEAR Wearable.png" alt="Wearable model"/></a>

  <figcaption id="Figure_4">Figure 4: Wearable model</figcaption>

</figure>





<h3>Function</h3>



<p>This model specifies the functions that are considered relevant for the wearables domain. We defined three new concepts that are subsumed by the <a href="https://saref.etsi.org/core/Function">saref:Function</a> concept and we reuse other functions defined in SAREF, as presented in <a href="#Figure_5">Figure 5</a>:

<ul>

<li><a href="https://saref.etsi.org/core/ActuatingFunction">saref:ActuatingFunction</a> defines the possibility of a <a href="#s4wear:Wearable">s4wear:Wearable</a> device to actuate over a feature of interest;</li>

<li><a href="#s4wear:CommunicatingFunction">s4wear:CommunicatingFunction</a> is a type of <a href="https://saref.etsi.org/core/EventFunction">saref:EventFunction</a> that defines the possibility of a <a href="#s4wear:Wearable">s4wear:Wearable</a> device to transmit data to another <a href="#s4wear:Wearable">s4wear:Wearable</a> device or any other <a href="https://saref.etsi.org/core/Device">saref:Device</a> able to receive data;</li>

<li><a href="#s4wear:ControllingFunction">s4wear:ControllingFunction</a> defines the possibility of a <a href="#s4wear:Wearable">s4wear:Wearable</a> device to control another object;</li>

<li><a href="#s4wear:NavigatingFunction">s4wear:NavigatingFunction</a> defines the possibility of a <a href="#s4wear:Wearable">s4wear:Wearable</a> device to provide navigation capabilities;</li>

<li><a href="https://saref.etsi.org/core/SensingFunction">saref:SensingFunction</a> defines the possibility of a <a href="#s4wear:Wearable">s4wear:Wearable</a> device to acquire data by means of sensors integrated into a <a href="#s4wear:Wearable">s4wear:Wearable</a> device.</li>

</ul>

</p>



<figure>

  <a href="diagrams/SAREF4WEAR Function.png"><img src="diagrams/SAREF4WEAR Function.png" alt="Function model"/></a>

  <figcaption id="Figure_5">Figure 5: Function model</figcaption>

</figure>





<h3>Occurrence</h3>



<p>In some cases, wearables will be able to detect occurrences (<a href="#s4wear:Occurrence">s4wear:Occurrence</a>) taking place (<a href="#s4wear:takesPlaceAt">s4wear:takesPlaceAt</a>) in a location that is relevant to the wearer (geosp:Feature). These occurrences can be related to the device detecting them through the <a href="#s4wear:isDetectedBy">s4wear:isDetectedBy</a> property, as shown in <a href="#Figure_6">Figure 6</a>.</p>

 

<p>In the context of a smart city, more specific classes can be used from SAREF4CITY, to represent events (<a href="https://saref.etsi.org/saref4city/Event">s4city:Event</a>, a subclass of <a href="#s4wear:Occurrence">s4wear:Occurrence</a>) that take place at (<a href="https://saref.etsi.org/saref4city/takesPlaceAtFacility">s4city:takesPlaceAtFacility</a>) facilities (<a href="https://saref.etsi.org/saref4city/Facility">s4city:Facility</a>, a subclass of geosp:Feature).</p> 



<figure>

  <a href="diagrams/SAREF4WEAR Occurrence.png"><img src="diagrams/SAREF4WEAR Occurrence.png" alt="Occurence model"/></a>

  <figcaption id="Figure_6">Figure 6: Occurrence model</figcaption>

</figure>





<h3>Property</h3>



<p>SAREF4WEAR includes a classification of the different properties that are relevant to the wearables domain, as shown in <a href="#Figure_7">Figure 7</a>. These properties are classified into wearable (<a href="#s4wear:WearableProperty">s4wear:WearableProperty</a>), wearer (<a href="#s4wear:WearerProperty">s4wear:WearerProperty</a>), crowd (<a href="#s4wear:CrowdProperty">s4wear:CrowdProperty</a>), and environment (<a href="#s4wear:EnvironmentProperty">s4wear:EnvironmentProperty</a>) ones.</p>

 

<p>Furthermore, wearable properties are further classified into electrical one (<a href="#s4wear:ElectricalProperty">s4wear:ElectricalProperty</a>) that refer to the electric information of a wearable, electrical safety ones (<a href="#s4wear:ElectricalSafetyProperty">s4wear:ElectricalSafetyProperty</a>) that refer to safety information concerning electrical aspects of wearables, and emission one (<a href="#s4wear:EmissionProperty">s4wear:EmissionProperty</a>) that refer to information about kind of emissions (e.g. noise, temperature, etc.) associated with a wearable.</p> 



<p>The extension defines different individuals for each type of water property; however, this list of individuals does not aim to be exhaustive but to reflect the potential use of the ontology.</p> 



<figure>

  <a href="diagrams/SAREF4WEAR Property.png"><img src="diagrams/SAREF4WEAR Property.png" alt="Property model"/></a>

  <figcaption id="Figure_7">Figure 7: Property model</figcaption>

</figure>





<h3>Wearable component</h3>



<p>This model describes some of the components that could be integrated into a <a href="#s4wear:Wearable">s4wear:Wearable</a> device. We foresee different types of components, as depicted in <a href="#Figure_8">Figure 8</a>:

<ul>

<li>a <a href="https://saref.etsi.org/core/Actuator">saref:Actuator</a> component, reused from the SAREF ontology;</li>

<li>a <a href="https://saref.etsi.org/core/Sensor">saref:Sensor</a> component, reused from the SAREF ontology, and a <a href="#s4wear:TextileBasedSensor">s4wear:TextileBasedSensor</a> component, subclass of the <a href="https://saref.etsi.org/core/Sensor">saref:Sensor</a> one, defining sensors that are installed directly on textile products;</li>

<li>a <a href="#s4wear:MemoryStorage">s4wear:MemoryStorage</a> component defining storage components that can be directly installed within a <a href="#s4wear:Wearable">s4wear:Wearable</a> device.</li>

</ul>

</p>



<figure>

  <a href="diagrams/SAREF4WEAR Wearable component.png"><img src="diagrams/SAREF4WEAR Wearable component.png" alt="Wearable component model"/></a>

  <figcaption id="Figure_8">Figure 8: Wearable component model</figcaption>

</figure>