Commit e74b8766 authored by María's avatar María
Browse files

documentation for envi

Include diagrams, example, an example reference (decide if add more),
fix labels in authors, fix label in license.
parent 0bf0c45f
Loading
Loading
Loading
Loading
+3 −4
Original line number Diff line number Diff line
@@ -31,22 +31,21 @@ function loadHash() {
<h1 property="dc:title schema:name">SAREF extension for environment</h1>
<dl>
<dt>This version:</dt>
<dd><a href="http://saref.linkeddata.es/def/v1/envi">http://saref.linkeddata.es/def/v1/envi</a></dd>
<dd><a href="https://w3id.org/def/v1/saref4envi">https://w3id.org/def/v1/saref4envi</a></dd>
</dl><dt>Revision:</dt>
<dd property="schema:version">1.0</dd>
<dl><dt>Authors:</dt>
<dd><a property="dc:creator schema:author prov:wasAttributedTo" resource="http://www.garcia-castro.com/foaf.rdf#me" href="http://www.garcia-castro.com/foaf.rdf#me">Raúl García Castro</a></dd><dd><a property="dc:creator schema:author prov:wasAttributedTo" resource="http://purl.org/net/mpoveda" href="http://purl.org/net/mpoveda">María Poveda</a></dd></dl>

<dl><dt>Download serialization:</dt><dd><span><a href="ontology.n3" target="_blank"><img src="https://img.shields.io/badge/Format-N_Triples-blue.svg"</img></a> </span><span><a href="ontology.xml" target="_blank"><img src="https://img.shields.io/badge/Format-RDF/XML-blue.svg"</img></a> </span><span><a href="ontology.ttl" target="_blank"><img src="https://img.shields.io/badge/Format-TTL-blue.svg"</img></a> </span></dd></dl><dl><dt>License: </dt><dd><a rel="license" href="http://purl.org/NET/rdflicense/cc-by4.0" target="_blank"><img src ="https://img.shields.io/badge/License-null-blue.svg"</img></a>
<dl><dt>Download serialization:</dt><dd><span><a href="ontology.n3" target="_blank"><img src="https://img.shields.io/badge/Format-N_Triples-blue.svg"</img></a> </span><span><a href="ontology.xml" target="_blank"><img src="https://img.shields.io/badge/Format-RDF/XML-blue.svg"</img></a> </span><span><a href="ontology.ttl" target="_blank"><img src="https://img.shields.io/badge/Format-TTL-blue.svg"</img></a> </span></dd></dl><dl><dt>License: </dt><dd><a rel="license" href="http://purl.org/NET/rdflicense/cc-by4.0" target="_blank"><img src ="https://img.shields.io/badge/License-Creative Commons CC_BY-blue.svg"</img></a>
<span property="dc:license" resource="http://purl.org/NET/rdflicense/cc-by4.0"></span>
<a property="dc:rights" href="http://purl.org/NET/rdflicense/cc-by4.0" rel="license" target="_blank">
<img src="null" style="border-width:0" alt="License"></img>
</a>
<br/></dd></dl><dl><a href="provenance/provenance-en.html" target="_blank">Provenance of this page</a></dl><hr/>
</div>
<div class="status">
<div>
<span>Specification Draft</span>
<span>SAREF4ENVI Specification</span>
</div>
</div>     <div id="abstract"></div>
<div id="toc"><h2>Table of contents</h2>
+30 −1
Original line number Diff line number Diff line
<h2>3. envi: Description <span class="backlink"> back to <a href="#toc">ToC</a></span></h2>
<p>Complete description of the ontology: a diagram explaining how the classes are related, examples of usage, etc.</p>
<p>Figure 1 provides a general overview of the SAREF4ENVI ontology. </p>
<center><img src="resources/images/saref4env.png" alt="SAREF4ENVI general diagram.">   <figcaption>Figure 1. - SAREF4ENVI general diagram.</figcaption></center>


<h3>Instantiating SAREF4ENVI <span class="backlink"> back to <a href="#toc">ToC</a></span></h3>

<p>This section shows an example of an instantiation of the SAREF4ENVI ontology. Such example aims to illustrate how to describe a given sensor, in this case a photometer, using the SAREF4ENVI ontology.  In addition, the example is complemented with energy consumption information for which the SAREF4ENER ontology is used. The example is graphically represented in Figure 2 and Figure 3 and the corresponding Turtle code is provided in <a href="http://saref.linkeddata.es/data/envi/example1">example code</a>.</p>

<p>The core part of the example, the information annotated by the SAREF4ENVI ontology, is depicted in Figure 2. In such figure a photometer named “stars5” is depicted by a purple box. This purple box represents the instance ex:TESS005-UC that belongs to the class s4envi:Tess. This photometer is named “stars5”, is manufactured by “Universidad Complutense de Madrid” and has version “1”, as indicated by the values of the datatype properties saref:hasName, saref:hasManufacturer and s4envi:hasVersion, respectively.</p>

<p>We can also see in Figure 2 that the photometer is located in a given point, represented by the instance ex:LocationTESS005-UCM, which has specific values for the geographical coordinates indicated by the properties geo:longitude and geo:latitude.</p>

<p>The communication protocol that the photometer uses is indicated by the object property s4envi:usesCommunicationProtocol which links the instance representing the photometer with an instance of the class s4envi:CommunicationProtocol named ex:MQTT-Broker that represents the protocol “MQTT Broker”. In addition, the photometer is able to use three different communication interfaces, namely RS232 v24, Bluetooth v2.1 and Wi-Fi v802.11ah. The photometer is linked to three different individuals that belong to the class s4envi:CommunicationInterface, each one representing one interface, by means of the property s4envi:usesCommunicationInterface. Each of these individuals has instantiated the datatype property s4envi:hasVersion in order to indicate the version of the communication interface.</p>

<p>The TESS photometer is able to measure light magnitude. It is indicated by the link between the photometer and the individual s4envi:LightMagnitude, which belongs to the class s4envi:LightProperty, using the property saref:measuresProperty.</p>

<p>The photometer has a frequency for taking one measurement every 10 seconds. This is represented by the property s4envi:hasFrequencyMeasurement that links the photometer with the instance ex:FrequencyMeasurementTESS005-UC which belongs to the class s4envi: FrequencyMeasurement. Such instance represents the value of the frequency by instantiating the datatype property saref:hasValue with the float value “10.0” and indicates the unit of measurement in which such value is measured by means of the object property saref:isMeasduredIn and the instance wurvoc:recriprocal_second-time reused from the OM ontology.</p>

<p>The photometer has a period for transmitting measurements of 30 seconds. This is represented by the property s4envi:hasTransmissionPeriod that links the photometer with the instance ex:PeriodTransmissionTESS005-UC, which belongs to the class s4envi:PeriodMeasurement. Such instance represents the value of the frequency by instantiating the datatype property saref:hasValue with the float value “30.0” and indicates the unit of measurement in which such value is measured by means of the object property saref:isMeasduredIn and the instance time:unitSecond reused from the time ontology.</p>

<p>The example also shows two measurements of light magnitude taken by the photometer. These measurements are represented by the instances ex:Measurement2016-10-05T08:15:30TESS005-UCM and ex:Measurement2016-10-05T08:15:40TESS005-UCM that belong to the class saref:Measurement. Such instances indicate which property the measurement is about by using the object property saref:relatesToProperty to link to the instance s4envi:LightMagnitude. The value of each measurement, “0.1” for the first one and “0.8” for the second one, is represented by the float value attached to the datatype property saref:hasValue. The unit of measurement in which the values are expressed is indicated by the instance ex:mgPerArcsec2. This instance is linked from the instance representing the measurement by the object property saref:isMeasuredIn. Finally, the time stamps when the measurements were taken are represented by the values linked from the datatype property saref:hasTimeStamp.</p>


<center><img src="resources/images/saref4envEx1.png" alt="Photometer TESS description example.">   <figcaption>Figure 2. - Photometer TESS description example.</figcaption></center>


<p>Figure 3 shows an example about combining ontological elements from the SAREF4ENVI ontology with the SAREF4ENER one. More precisely, it indicates the power consumption of the TESS photometer described above. For doing so, the instance representing the photometer, namely ex:TESS005-UCM, is linked to an instance named ex:PowerProfileTESS005-UCM that belongs to the class s4ee:PowerProfile which represents the power profile of the photometer. This latter instance indicates the photometer power consumption by linking, using the object property saref:hasConsumption, to an instance named ex:PowerTESS005-UCM that belongs to the class s4ener:Power. Finally, this instance indicates the power consumption value “20.0” by means of the datatype property saref:hasValue and the unit in which such value is measured by means of the object property saref:isMeasuredIn that points to the instance wurvoc:watt.</p> 


<center><img src="resources/images/saref4envEx2.png" alt="Photometer TESS related to the energy extension example.">   <figcaption>Figure 3. - Photometer TESS related to the energy extension example.</figcaption></center>
Loading